From 015ef933999e796678e66335fa33b85382aabd6b Mon Sep 17 00:00:00 2001 From: Stacey Gammon Date: Thu, 25 Feb 2021 17:41:47 -0500 Subject: [PATCH 01/10] update api_docs from gitignore --- .gitignore | 1 - dev_docs/api_welcome.mdx | 45 +++++++++++++++++++++++++++++++++++++--- 2 files changed, 42 insertions(+), 4 deletions(-) diff --git a/.gitignore b/.gitignore index 1a4ffefd6d12f..fbe28b8f1e77c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,5 @@ .aws-config.json .signing-config.json -/api_docs .ackrc /.es /.chromium diff --git a/dev_docs/api_welcome.mdx b/dev_docs/api_welcome.mdx index 692a1bb2e582e..ea53101d150e1 100644 --- a/dev_docs/api_welcome.mdx +++ b/dev_docs/api_welcome.mdx @@ -3,12 +3,51 @@ id: kibDevDocsApiWelcome slug: /kibana-dev-docs/api-welcome title: Welcome summary: The home of automatically generated plugin API documentation using extracted TSDocs -date: 2021-01-02 +date: 2021-02-25 tags: ['kibana','dev', 'contributor', 'api docs'] --- -Welcome to Kibana's plugin API documentation. As a plugin developer, this is where you can -learn the details of every service you can take advantage of to help you build awe-inspiring creative solutions and applications! +Welcome to Kibana's plugin API documentation! As a plugin developer, this is where you can +learn the details of every service you can take advantage of to help you build awe-inspiring + creative solutions and applications! + + +This documentation is being automatically generated using an + [_experimental_ system](https://github.com/elastic/kibana/blob/master/rfcs/text/0014_api_documentation.md). That means + it may be removed or modified. Please create an issue + + + ## What is included + + Every plugin that exposes functionality for other plugins to use exposes a + (note this system + does *not* handle REST APIs). The API documentation system detects this and automatically generates API documentation for + these public services. + + API items that have an `@internal` in the comment are not + included in the documentation system. + + ## How it works + +There is one extra step required to have your API docs show up in the _navigation_ of the docs system. Follow +the instructions to learn how to +configure the navigation menu. This is the nav file you will +be editing: [https://github.com/elastic/elastic-docs/blob/master/config/nav-kibana-dev.ts](https://github.com/elastic/elastic-docs/blob/master/config/nav-kibana-dev.ts) + +Your API docs will exist in the top level `api_docs` folder and will use a doc id of the pattern `kib${PluginName}PluginApi`. + +If you have a very large plugin you can split up the documentation by adding a `serviceFolders` section into your `kibana.json` that matches +folder names. This will automatically group any API items that are defined in those "service folders" into a separate doc with a doc id of +`kib${PluginName}${ServiceName}PluginApi`. The data plugin does this, so you can check that out as an example. + + ## Handling API changes in PRs + + If you change or delete an existing API, or add a new one, you will have to run the command `node scripts/build_api_docs` in order to update the + docs in your PR, or CI will fail. When this happens, consider: + + 1. If this affects an existing API item, have you emailed the `kibana-contributors` list with a heads up? It's important to give advance + notice, since there may be corner cases you aren't aware of, even if your PR passes CI. + 2. If the change you are making isn't relevant to contributors, consider a) making the API private, or b) adding the `@internal` flag to it. If you have any questions or issues, please reach out to the Kibana platform team or create an issue [here](https://github.com/elastic/kibana/issues). From 0491df895a11bf8af4bf11a5a518d05ce8f7deff Mon Sep 17 00:00:00 2001 From: Stacey Gammon Date: Thu, 25 Feb 2021 19:16:22 -0500 Subject: [PATCH 02/10] api doc files --- api_docs/actions.json | 1 + api_docs/actions.mdx | 32 +++++++++++ api_docs/advanced_settings.json | 1 + api_docs/advanced_settings.mdx | 22 ++++++++ api_docs/alerts.json | 1 + api_docs/alerts.mdx | 38 +++++++++++++ api_docs/apm.json | 1 + api_docs/apm.mdx | 30 +++++++++++ api_docs/apm_oss.json | 1 + api_docs/apm_oss.mdx | 28 ++++++++++ api_docs/banners.json | 1 + api_docs/banners.mdx | 18 +++++++ api_docs/beats_management.json | 1 + api_docs/beats_management.mdx | 18 +++++++ api_docs/bfetch.json | 1 + api_docs/bfetch.mdx | 38 +++++++++++++ api_docs/canvas.json | 1 + api_docs/canvas.mdx | 20 +++++++ api_docs/case.json | 1 + api_docs/case.mdx | 16 ++++++ api_docs/charts.json | 1 + api_docs/charts.mdx | 34 ++++++++++++ api_docs/cloud.json | 1 + api_docs/cloud.mdx | 22 ++++++++ api_docs/console.json | 1 + api_docs/console.mdx | 18 +++++++ api_docs/core.json | 1 + api_docs/core.mdx | 32 +++++++++++ api_docs/core_application.json | 1 + api_docs/core_application.mdx | 22 ++++++++ api_docs/core_chrome.json | 1 + api_docs/core_chrome.mdx | 18 +++++++ api_docs/core_http.json | 1 + api_docs/core_http.mdx | 32 +++++++++++ api_docs/core_saved_objects.json | 1 + api_docs/core_saved_objects.mdx | 28 ++++++++++ api_docs/dashboard.json | 1 + api_docs/dashboard.mdx | 36 +++++++++++++ api_docs/dashboard_enhanced.json | 1 + api_docs/dashboard_enhanced.mdx | 38 +++++++++++++ api_docs/dashboard_mode.json | 1 + api_docs/dashboard_mode.mdx | 20 +++++++ api_docs/data.json | 1 + api_docs/data.mdx | 62 ++++++++++++++++++++++ api_docs/data_autocomplete.json | 1 + api_docs/data_autocomplete.mdx | 20 +++++++ api_docs/data_enhanced.json | 1 + api_docs/data_enhanced.mdx | 34 ++++++++++++ api_docs/data_field_formats.json | 1 + api_docs/data_field_formats.mdx | 30 +++++++++++ api_docs/data_index_patterns.json | 1 + api_docs/data_index_patterns.mdx | 32 +++++++++++ api_docs/data_query.json | 1 + api_docs/data_query.mdx | 32 +++++++++++ api_docs/data_search.json | 1 + api_docs/data_search.mdx | 48 +++++++++++++++++ api_docs/data_ui.json | 1 + api_docs/data_ui.mdx | 20 +++++++ api_docs/dev_tools.json | 1 + api_docs/dev_tools.mdx | 18 +++++++ api_docs/discover.json | 1 + api_docs/discover.mdx | 28 ++++++++++ api_docs/discover_enhanced.json | 1 + api_docs/discover_enhanced.mdx | 22 ++++++++ api_docs/embeddable.json | 1 + api_docs/embeddable.mdx | 48 +++++++++++++++++ api_docs/embeddable_enhanced.json | 1 + api_docs/embeddable_enhanced.mdx | 24 +++++++++ api_docs/encrypted_saved_objects.json | 1 + api_docs/encrypted_saved_objects.mdx | 22 ++++++++ api_docs/enterprise_search.json | 1 + api_docs/enterprise_search.mdx | 18 +++++++ api_docs/es_ui_shared.json | 1 + api_docs/es_ui_shared.mdx | 32 +++++++++++ api_docs/event_log.json | 1 + api_docs/event_log.mdx | 26 +++++++++ api_docs/expressions.json | 1 + api_docs/expressions.mdx | 58 ++++++++++++++++++++ api_docs/features.json | 1 + api_docs/features.mdx | 38 +++++++++++++ api_docs/file_upload.json | 1 + api_docs/file_upload.mdx | 26 +++++++++ api_docs/fleet.json | 1 + api_docs/fleet.mdx | 54 +++++++++++++++++++ api_docs/global_search.json | 1 + api_docs/global_search.mdx | 32 +++++++++++ api_docs/home.json | 1 + api_docs/home.mdx | 42 +++++++++++++++ api_docs/index_lifecycle_management.json | 1 + api_docs/index_lifecycle_management.mdx | 18 +++++++ api_docs/index_management.json | 1 + api_docs/index_management.mdx | 34 ++++++++++++ api_docs/index_pattern_field_editor.json | 1 + api_docs/index_pattern_field_editor.mdx | 20 +++++++ api_docs/index_pattern_management.json | 1 + api_docs/index_pattern_management.mdx | 24 +++++++++ api_docs/infra.json | 1 + api_docs/infra.mdx | 28 ++++++++++ api_docs/ingest_pipelines.json | 1 + api_docs/ingest_pipelines.mdx | 20 +++++++ api_docs/inspector.json | 1 + api_docs/inspector.mdx | 34 ++++++++++++ api_docs/kibana_legacy.json | 1 + api_docs/kibana_legacy.mdx | 22 ++++++++ api_docs/kibana_react.json | 1 + api_docs/kibana_react.mdx | 30 +++++++++++ api_docs/kibana_utils.json | 1 + api_docs/kibana_utils.mdx | 46 ++++++++++++++++ api_docs/lens.json | 1 + api_docs/lens.mdx | 32 +++++++++++ api_docs/license_management.json | 1 + api_docs/license_management.mdx | 18 +++++++ api_docs/licensing.json | 1 + api_docs/licensing.mdx | 38 +++++++++++++ api_docs/lists.json | 1 + api_docs/lists.mdx | 38 +++++++++++++ api_docs/management.json | 1 + api_docs/management.mdx | 24 +++++++++ api_docs/maps.json | 1 + api_docs/maps.mdx | 20 +++++++ api_docs/maps_legacy.json | 1 + api_docs/maps_legacy.mdx | 22 ++++++++ api_docs/ml.json | 1 + api_docs/ml.mdx | 56 +++++++++++++++++++ api_docs/monitoring.json | 1 + api_docs/monitoring.mdx | 20 +++++++ api_docs/navigation.json | 1 + api_docs/navigation.mdx | 26 +++++++++ api_docs/newsfeed.json | 1 + api_docs/newsfeed.mdx | 22 ++++++++ api_docs/observability.json | 1 + api_docs/observability.mdx | 38 +++++++++++++ api_docs/osquery.json | 1 + api_docs/osquery.mdx | 28 ++++++++++ api_docs/presentation_util.json | 1 + api_docs/presentation_util.mdx | 22 ++++++++ api_docs/remote_clusters.json | 1 + api_docs/remote_clusters.mdx | 20 +++++++ api_docs/reporting.json | 1 + api_docs/reporting.mdx | 34 ++++++++++++ api_docs/rollup.json | 1 + api_docs/rollup.mdx | 18 +++++++ api_docs/runtime_fields.json | 1 + api_docs/runtime_fields.mdx | 22 ++++++++ api_docs/saved_objects.json | 1 + api_docs/saved_objects.mdx | 30 +++++++++++ api_docs/saved_objects_management.json | 1 + api_docs/saved_objects_management.mdx | 32 +++++++++++ api_docs/saved_objects_tagging.json | 1 + api_docs/saved_objects_tagging.mdx | 26 +++++++++ api_docs/saved_objects_tagging_oss.json | 1 + api_docs/saved_objects_tagging_oss.mdx | 26 +++++++++ api_docs/searchprofiler.json | 1 + api_docs/searchprofiler.mdx | 18 +++++++ api_docs/security.json | 1 + api_docs/security.mdx | 26 +++++++++ api_docs/security_oss.json | 1 + api_docs/security_oss.mdx | 26 +++++++++ api_docs/security_solution.json | 1 + api_docs/security_solution.mdx | 42 +++++++++++++++ api_docs/share.json | 1 + api_docs/share.mdx | 30 +++++++++++ api_docs/snapshot_restore.json | 1 + api_docs/snapshot_restore.mdx | 20 +++++++ api_docs/spaces.json | 1 + api_docs/spaces.mdx | 44 +++++++++++++++ api_docs/spaces_oss.json | 1 + api_docs/spaces_oss.mdx | 24 +++++++++ api_docs/stack_alerts.json | 1 + api_docs/stack_alerts.mdx | 22 ++++++++ api_docs/task_manager.json | 1 + api_docs/task_manager.mdx | 28 ++++++++++ api_docs/telemetry.json | 1 + api_docs/telemetry.mdx | 32 +++++++++++ api_docs/telemetry_collection_manager.json | 1 + api_docs/telemetry_collection_manager.mdx | 22 ++++++++ api_docs/telemetry_collection_xpack.json | 1 + api_docs/telemetry_collection_xpack.mdx | 16 ++++++ api_docs/telemetry_management_section.json | 1 + api_docs/telemetry_management_section.mdx | 18 +++++++ api_docs/triggers_actions_ui.json | 1 + api_docs/triggers_actions_ui.mdx | 46 ++++++++++++++++ api_docs/ui_actions.json | 1 + api_docs/ui_actions.mdx | 28 ++++++++++ api_docs/ui_actions_enhanced.json | 1 + api_docs/ui_actions_enhanced.mdx | 42 +++++++++++++++ api_docs/uptime.json | 1 + api_docs/uptime.mdx | 18 +++++++ api_docs/url_forwarding.json | 1 + api_docs/url_forwarding.mdx | 20 +++++++ api_docs/usage_collection.json | 1 + api_docs/usage_collection.mdx | 30 +++++++++++ api_docs/vis_type_timeseries.json | 1 + api_docs/vis_type_timeseries.mdx | 16 ++++++ api_docs/visualizations.json | 1 + api_docs/visualizations.mdx | 34 ++++++++++++ 196 files changed, 2914 insertions(+) create mode 100644 api_docs/actions.json create mode 100644 api_docs/actions.mdx create mode 100644 api_docs/advanced_settings.json create mode 100644 api_docs/advanced_settings.mdx create mode 100644 api_docs/alerts.json create mode 100644 api_docs/alerts.mdx create mode 100644 api_docs/apm.json create mode 100644 api_docs/apm.mdx create mode 100644 api_docs/apm_oss.json create mode 100644 api_docs/apm_oss.mdx create mode 100644 api_docs/banners.json create mode 100644 api_docs/banners.mdx create mode 100644 api_docs/beats_management.json create mode 100644 api_docs/beats_management.mdx create mode 100644 api_docs/bfetch.json create mode 100644 api_docs/bfetch.mdx create mode 100644 api_docs/canvas.json create mode 100644 api_docs/canvas.mdx create mode 100644 api_docs/case.json create mode 100644 api_docs/case.mdx create mode 100644 api_docs/charts.json create mode 100644 api_docs/charts.mdx create mode 100644 api_docs/cloud.json create mode 100644 api_docs/cloud.mdx create mode 100644 api_docs/console.json create mode 100644 api_docs/console.mdx create mode 100644 api_docs/core.json create mode 100644 api_docs/core.mdx create mode 100644 api_docs/core_application.json create mode 100644 api_docs/core_application.mdx create mode 100644 api_docs/core_chrome.json create mode 100644 api_docs/core_chrome.mdx create mode 100644 api_docs/core_http.json create mode 100644 api_docs/core_http.mdx create mode 100644 api_docs/core_saved_objects.json create mode 100644 api_docs/core_saved_objects.mdx create mode 100644 api_docs/dashboard.json create mode 100644 api_docs/dashboard.mdx create mode 100644 api_docs/dashboard_enhanced.json create mode 100644 api_docs/dashboard_enhanced.mdx create mode 100644 api_docs/dashboard_mode.json create mode 100644 api_docs/dashboard_mode.mdx create mode 100644 api_docs/data.json create mode 100644 api_docs/data.mdx create mode 100644 api_docs/data_autocomplete.json create mode 100644 api_docs/data_autocomplete.mdx create mode 100644 api_docs/data_enhanced.json create mode 100644 api_docs/data_enhanced.mdx create mode 100644 api_docs/data_field_formats.json create mode 100644 api_docs/data_field_formats.mdx create mode 100644 api_docs/data_index_patterns.json create mode 100644 api_docs/data_index_patterns.mdx create mode 100644 api_docs/data_query.json create mode 100644 api_docs/data_query.mdx create mode 100644 api_docs/data_search.json create mode 100644 api_docs/data_search.mdx create mode 100644 api_docs/data_ui.json create mode 100644 api_docs/data_ui.mdx create mode 100644 api_docs/dev_tools.json create mode 100644 api_docs/dev_tools.mdx create mode 100644 api_docs/discover.json create mode 100644 api_docs/discover.mdx create mode 100644 api_docs/discover_enhanced.json create mode 100644 api_docs/discover_enhanced.mdx create mode 100644 api_docs/embeddable.json create mode 100644 api_docs/embeddable.mdx create mode 100644 api_docs/embeddable_enhanced.json create mode 100644 api_docs/embeddable_enhanced.mdx create mode 100644 api_docs/encrypted_saved_objects.json create mode 100644 api_docs/encrypted_saved_objects.mdx create mode 100644 api_docs/enterprise_search.json create mode 100644 api_docs/enterprise_search.mdx create mode 100644 api_docs/es_ui_shared.json create mode 100644 api_docs/es_ui_shared.mdx create mode 100644 api_docs/event_log.json create mode 100644 api_docs/event_log.mdx create mode 100644 api_docs/expressions.json create mode 100644 api_docs/expressions.mdx create mode 100644 api_docs/features.json create mode 100644 api_docs/features.mdx create mode 100644 api_docs/file_upload.json create mode 100644 api_docs/file_upload.mdx create mode 100644 api_docs/fleet.json create mode 100644 api_docs/fleet.mdx create mode 100644 api_docs/global_search.json create mode 100644 api_docs/global_search.mdx create mode 100644 api_docs/home.json create mode 100644 api_docs/home.mdx create mode 100644 api_docs/index_lifecycle_management.json create mode 100644 api_docs/index_lifecycle_management.mdx create mode 100644 api_docs/index_management.json create mode 100644 api_docs/index_management.mdx create mode 100644 api_docs/index_pattern_field_editor.json create mode 100644 api_docs/index_pattern_field_editor.mdx create mode 100644 api_docs/index_pattern_management.json create mode 100644 api_docs/index_pattern_management.mdx create mode 100644 api_docs/infra.json create mode 100644 api_docs/infra.mdx create mode 100644 api_docs/ingest_pipelines.json create mode 100644 api_docs/ingest_pipelines.mdx create mode 100644 api_docs/inspector.json create mode 100644 api_docs/inspector.mdx create mode 100644 api_docs/kibana_legacy.json create mode 100644 api_docs/kibana_legacy.mdx create mode 100644 api_docs/kibana_react.json create mode 100644 api_docs/kibana_react.mdx create mode 100644 api_docs/kibana_utils.json create mode 100644 api_docs/kibana_utils.mdx create mode 100644 api_docs/lens.json create mode 100644 api_docs/lens.mdx create mode 100644 api_docs/license_management.json create mode 100644 api_docs/license_management.mdx create mode 100644 api_docs/licensing.json create mode 100644 api_docs/licensing.mdx create mode 100644 api_docs/lists.json create mode 100644 api_docs/lists.mdx create mode 100644 api_docs/management.json create mode 100644 api_docs/management.mdx create mode 100644 api_docs/maps.json create mode 100644 api_docs/maps.mdx create mode 100644 api_docs/maps_legacy.json create mode 100644 api_docs/maps_legacy.mdx create mode 100644 api_docs/ml.json create mode 100644 api_docs/ml.mdx create mode 100644 api_docs/monitoring.json create mode 100644 api_docs/monitoring.mdx create mode 100644 api_docs/navigation.json create mode 100644 api_docs/navigation.mdx create mode 100644 api_docs/newsfeed.json create mode 100644 api_docs/newsfeed.mdx create mode 100644 api_docs/observability.json create mode 100644 api_docs/observability.mdx create mode 100644 api_docs/osquery.json create mode 100644 api_docs/osquery.mdx create mode 100644 api_docs/presentation_util.json create mode 100644 api_docs/presentation_util.mdx create mode 100644 api_docs/remote_clusters.json create mode 100644 api_docs/remote_clusters.mdx create mode 100644 api_docs/reporting.json create mode 100644 api_docs/reporting.mdx create mode 100644 api_docs/rollup.json create mode 100644 api_docs/rollup.mdx create mode 100644 api_docs/runtime_fields.json create mode 100644 api_docs/runtime_fields.mdx create mode 100644 api_docs/saved_objects.json create mode 100644 api_docs/saved_objects.mdx create mode 100644 api_docs/saved_objects_management.json create mode 100644 api_docs/saved_objects_management.mdx create mode 100644 api_docs/saved_objects_tagging.json create mode 100644 api_docs/saved_objects_tagging.mdx create mode 100644 api_docs/saved_objects_tagging_oss.json create mode 100644 api_docs/saved_objects_tagging_oss.mdx create mode 100644 api_docs/searchprofiler.json create mode 100644 api_docs/searchprofiler.mdx create mode 100644 api_docs/security.json create mode 100644 api_docs/security.mdx create mode 100644 api_docs/security_oss.json create mode 100644 api_docs/security_oss.mdx create mode 100644 api_docs/security_solution.json create mode 100644 api_docs/security_solution.mdx create mode 100644 api_docs/share.json create mode 100644 api_docs/share.mdx create mode 100644 api_docs/snapshot_restore.json create mode 100644 api_docs/snapshot_restore.mdx create mode 100644 api_docs/spaces.json create mode 100644 api_docs/spaces.mdx create mode 100644 api_docs/spaces_oss.json create mode 100644 api_docs/spaces_oss.mdx create mode 100644 api_docs/stack_alerts.json create mode 100644 api_docs/stack_alerts.mdx create mode 100644 api_docs/task_manager.json create mode 100644 api_docs/task_manager.mdx create mode 100644 api_docs/telemetry.json create mode 100644 api_docs/telemetry.mdx create mode 100644 api_docs/telemetry_collection_manager.json create mode 100644 api_docs/telemetry_collection_manager.mdx create mode 100644 api_docs/telemetry_collection_xpack.json create mode 100644 api_docs/telemetry_collection_xpack.mdx create mode 100644 api_docs/telemetry_management_section.json create mode 100644 api_docs/telemetry_management_section.mdx create mode 100644 api_docs/triggers_actions_ui.json create mode 100644 api_docs/triggers_actions_ui.mdx create mode 100644 api_docs/ui_actions.json create mode 100644 api_docs/ui_actions.mdx create mode 100644 api_docs/ui_actions_enhanced.json create mode 100644 api_docs/ui_actions_enhanced.mdx create mode 100644 api_docs/uptime.json create mode 100644 api_docs/uptime.mdx create mode 100644 api_docs/url_forwarding.json create mode 100644 api_docs/url_forwarding.mdx create mode 100644 api_docs/usage_collection.json create mode 100644 api_docs/usage_collection.mdx create mode 100644 api_docs/vis_type_timeseries.json create mode 100644 api_docs/vis_type_timeseries.mdx create mode 100644 api_docs/visualizations.json create mode 100644 api_docs/visualizations.mdx diff --git a/api_docs/actions.json b/api_docs/actions.json new file mode 100644 index 0000000000000..7c26248a3a722 --- /dev/null +++ b/api_docs/actions.json @@ -0,0 +1 @@ +{"id":"actions","client":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"server":{"classes":[],"functions":[{"id":"def-server.asSavedObjectExecutionSource","type":"Function","label":"asSavedObjectExecutionSource","signature":["(source: Pick<","SavedObjectReference",", \"type\" | \"id\">) => ","SavedObjectExecutionSource"],"description":[],"children":[{"type":"Object","label":"source","isRequired":true,"signature":["Pick<",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},", \"type\" | \"id\">"],"description":[],"source":{"path":"x-pack/plugins/actions/server/lib/action_execution_source.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/lib/action_execution_source.ts#L30"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/actions/server/lib/action_execution_source.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/lib/action_execution_source.ts#L29"},"initialIsOpen":false},{"id":"def-server.asHttpRequestExecutionSource","type":"Function","label":"asHttpRequestExecutionSource","signature":["(source: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},") => ","HttpRequestExecutionSource"],"description":[],"children":[{"type":"Object","label":"source","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},""],"description":[],"source":{"path":"x-pack/plugins/actions/server/lib/action_execution_source.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/lib/action_execution_source.ts#L22"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/actions/server/lib/action_execution_source.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/lib/action_execution_source.ts#L22"},"initialIsOpen":false}],"interfaces":[{"id":"def-server.ActionsPlugin","type":"Interface","label":"ActionsPlugin","description":[],"children":[{"id":"def-server.ActionsPlugin.setup","type":"Object","label":"setup","description":[],"source":{"path":"x-pack/plugins/actions/server/types.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L56"},"signature":[{"pluginId":"actions","scope":"server","docId":"kibActionsPluginApi","section":"def-server.PluginSetupContract","text":"PluginSetupContract"}]},{"id":"def-server.ActionsPlugin.start","type":"Object","label":"start","description":[],"source":{"path":"x-pack/plugins/actions/server/types.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L57"},"signature":[{"pluginId":"actions","scope":"server","docId":"kibActionsPluginApi","section":"def-server.PluginStartContract","text":"PluginStartContract"}]}],"source":{"path":"x-pack/plugins/actions/server/types.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L55"},"initialIsOpen":false},{"id":"def-server.ActionResult","type":"Interface","label":"ActionResult","signature":[{"pluginId":"actions","scope":"server","docId":"kibActionsPluginApi","section":"def-server.ActionResult","text":"ActionResult"},""],"description":[],"children":[{"id":"def-server.ActionResult.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/actions/server/types.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L70"}},{"id":"def-server.ActionResult.actionTypeId","type":"string","label":"actionTypeId","description":[],"source":{"path":"x-pack/plugins/actions/server/types.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L71"}},{"id":"def-server.ActionResult.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/actions/server/types.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L72"}},{"id":"def-server.ActionResult.config","type":"Uncategorized","label":"config","description":[],"source":{"path":"x-pack/plugins/actions/server/types.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L73"},"signature":["Config | undefined"]},{"id":"def-server.ActionResult.isPreconfigured","type":"boolean","label":"isPreconfigured","description":[],"source":{"path":"x-pack/plugins/actions/server/types.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L74"}}],"source":{"path":"x-pack/plugins/actions/server/types.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L69"},"initialIsOpen":false},{"id":"def-server.ActionTypeExecutorOptions","type":"Interface","label":"ActionTypeExecutorOptions","signature":[{"pluginId":"actions","scope":"server","docId":"kibActionsPluginApi","section":"def-server.ActionTypeExecutorOptions","text":"ActionTypeExecutorOptions"},""],"description":[],"children":[{"id":"def-server.ActionTypeExecutorOptions.actionId","type":"string","label":"actionId","description":[],"source":{"path":"x-pack/plugins/actions/server/types.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L62"}},{"id":"def-server.ActionTypeExecutorOptions.services","type":"Object","label":"services","description":[],"source":{"path":"x-pack/plugins/actions/server/types.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L63"},"signature":[{"pluginId":"actions","scope":"server","docId":"kibActionsPluginApi","section":"def-server.Services","text":"Services"}]},{"id":"def-server.ActionTypeExecutorOptions.config","type":"Uncategorized","label":"config","description":[],"source":{"path":"x-pack/plugins/actions/server/types.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L64"},"signature":["Config"]},{"id":"def-server.ActionTypeExecutorOptions.secrets","type":"Uncategorized","label":"secrets","description":[],"source":{"path":"x-pack/plugins/actions/server/types.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L65"},"signature":["Secrets"]},{"id":"def-server.ActionTypeExecutorOptions.params","type":"Uncategorized","label":"params","description":[],"source":{"path":"x-pack/plugins/actions/server/types.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L66"},"signature":["Params"]}],"source":{"path":"x-pack/plugins/actions/server/types.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L61"},"initialIsOpen":false},{"id":"def-server.ActionType","type":"Interface","label":"ActionType","signature":[{"pluginId":"actions","scope":"server","docId":"kibActionsPluginApi","section":"def-server.ActionType","text":"ActionType"},""],"description":[],"children":[{"id":"def-server.ActionType.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/actions/server/types.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L108"}},{"id":"def-server.ActionType.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/actions/server/types.ts","lineNumber":109,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L109"}},{"id":"def-server.ActionType.maxAttempts","type":"number","label":"maxAttempts","description":[],"source":{"path":"x-pack/plugins/actions/server/types.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L110"},"signature":["number | undefined"]},{"id":"def-server.ActionType.minimumLicenseRequired","type":"CompoundType","label":"minimumLicenseRequired","description":[],"source":{"path":"x-pack/plugins/actions/server/types.ts","lineNumber":111,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L111"},"signature":["\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""]},{"id":"def-server.ActionType.validate","type":"Object","label":"validate","description":[],"source":{"path":"x-pack/plugins/actions/server/types.ts","lineNumber":112,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L112"},"signature":["{ params?: ValidatorType | undefined; config?: ValidatorType | undefined; secrets?: ValidatorType | undefined; } | undefined"]},{"id":"def-server.ActionType.renderParameterTemplates","type":"Function","label":"renderParameterTemplates","signature":["((params: Params, variables: Record) => Params) | undefined"],"description":[],"children":[{"type":"Uncategorized","label":"params","isRequired":true,"signature":["Params"],"description":[],"source":{"path":"x-pack/plugins/actions/server/types.ts","lineNumber":117,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L117"}},{"type":"Object","label":"variables","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"x-pack/plugins/actions/server/types.ts","lineNumber":117,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L117"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/actions/server/types.ts","lineNumber":117,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L117"}},{"id":"def-server.ActionType.executor","type":"Function","label":"executor","description":[],"source":{"path":"x-pack/plugins/actions/server/types.ts","lineNumber":118,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L118"},"signature":[{"pluginId":"actions","scope":"server","docId":"kibActionsPluginApi","section":"def-server.ExecutorType","text":"ExecutorType"},""]}],"source":{"path":"x-pack/plugins/actions/server/types.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L102"},"initialIsOpen":false},{"id":"def-server.PreConfiguredAction","type":"Interface","label":"PreConfiguredAction","signature":[{"pluginId":"actions","scope":"server","docId":"kibActionsPluginApi","section":"def-server.PreConfiguredAction","text":"PreConfiguredAction"}," extends ",{"pluginId":"actions","scope":"server","docId":"kibActionsPluginApi","section":"def-server.ActionResult","text":"ActionResult"},""],"description":[],"children":[{"id":"def-server.PreConfiguredAction.secrets","type":"Uncategorized","label":"secrets","description":[],"source":{"path":"x-pack/plugins/actions/server/types.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L81"},"signature":["Secrets"]}],"source":{"path":"x-pack/plugins/actions/server/types.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L77"},"initialIsOpen":false},{"id":"def-server.ActionsApiRequestHandlerContext","type":"Interface","label":"ActionsApiRequestHandlerContext","description":[],"children":[{"id":"def-server.ActionsApiRequestHandlerContext.getActionsClient","type":"Function","label":"getActionsClient","description":[],"source":{"path":"x-pack/plugins/actions/server/types.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L47"},"signature":["() => ",{"pluginId":"actions","scope":"server","docId":"kibActionsPluginApi","section":"def-server.ActionsClient","text":"ActionsClient"}]},{"id":"def-server.ActionsApiRequestHandlerContext.listTypes","type":"Function","label":"listTypes","description":[],"source":{"path":"x-pack/plugins/actions/server/types.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L48"},"signature":["() => ",{"pluginId":"actions","scope":"common","docId":"kibActionsPluginApi","section":"def-common.ActionType","text":"ActionType"},"[]"]}],"source":{"path":"x-pack/plugins/actions/server/types.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/types.ts#L46"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-server.ActionsClient","type":"Type","label":"ActionsClient","description":[],"source":{"path":"x-pack/plugins/actions/server/index.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/index.ts#L15"},"signature":["{ get: ({ id }: { id: string; }) => Promise<",{"pluginId":"actions","scope":"server","docId":"kibActionsPluginApi","section":"def-server.ActionResult","text":"ActionResult"},">>; delete: ({ id }: { id: string; }) => Promise<{}>; create: ({ action: { actionTypeId, name, config, secrets }, }: CreateOptions) => Promise<",{"pluginId":"actions","scope":"server","docId":"kibActionsPluginApi","section":"def-server.ActionResult","text":"ActionResult"},">>; update: ({ id, action }: UpdateOptions) => Promise<",{"pluginId":"actions","scope":"server","docId":"kibActionsPluginApi","section":"def-server.ActionResult","text":"ActionResult"},">>; execute: ({ actionId, params, source, }: Pick<","ExecuteOptions",", \"source\" | \"params\" | \"actionId\">) => Promise<",{"pluginId":"actions","scope":"common","docId":"kibActionsPluginApi","section":"def-common.ActionTypeExecutorResult","text":"ActionTypeExecutorResult"}],"initialIsOpen":false},{"id":"def-server.ActionsAuthorization","type":"Type","label":"ActionsAuthorization","description":[],"source":{"path":"x-pack/plugins/actions/server/index.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/index.ts#L16"},"signature":["{ ensureAuthorized: (operation: string, actionTypeId?: string | undefined) => Promise; }"],"initialIsOpen":false},{"id":"def-server.ActionTypeId","type":"string","label":"ActionTypeId","description":[],"source":{"path":"x-pack/plugins/actions/server/builtin_action_types/email.ts","lineNumber":143,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/email.ts#L143"},"signature":["\".email\""],"initialIsOpen":false},{"id":"def-server.ActionParamsType","type":"Type","label":"ActionParamsType","description":[],"source":{"path":"x-pack/plugins/actions/server/builtin_action_types/email.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/email.ts#L99"},"signature":["{ readonly to: string[]; readonly message: string; readonly cc: string[]; readonly bcc: string[]; readonly subject: string; readonly kibanaFooterLink: Readonly<{} & { text: string; path: string; }>; }"],"initialIsOpen":false},{"id":"def-server.ActionTypeId","type":"string","label":"ActionTypeId","description":[],"source":{"path":"x-pack/plugins/actions/server/builtin_action_types/es_index.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/es_index.ts#L43"},"signature":["\".index\""],"initialIsOpen":false},{"id":"def-server.ActionParamsType","type":"Type","label":"ActionParamsType","description":[],"source":{"path":"x-pack/plugins/actions/server/builtin_action_types/es_index.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/es_index.ts#L34"},"signature":["{ readonly documents: Record[]; }"],"initialIsOpen":false},{"id":"def-server.ActionTypeId","type":"string","label":"ActionTypeId","description":[],"source":{"path":"x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts","lineNumber":121,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/pagerduty.ts#L121"},"signature":["\".pagerduty\""],"initialIsOpen":false},{"id":"def-server.ActionParamsType","type":"Type","label":"ActionParamsType","description":[],"source":{"path":"x-pack/plugins/actions/server/builtin_action_types/pagerduty.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/pagerduty.ts#L50"},"signature":["{ readonly source?: string | undefined; readonly summary?: string | undefined; readonly eventAction?: \"resolve\" | \"trigger\" | \"acknowledge\" | undefined; readonly dedupKey?: string | undefined; readonly severity?: \"warning\" | \"info\" | \"error\" | \"critical\" | undefined; readonly timestamp?: string | undefined; readonly component?: string | undefined; readonly group?: string | undefined; readonly class?: string | undefined; }"],"initialIsOpen":false},{"id":"def-server.ActionTypeId","type":"string","label":"ActionTypeId","description":[],"source":{"path":"x-pack/plugins/actions/server/builtin_action_types/server_log.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/server_log.ts#L42"},"signature":["\".server-log\""],"initialIsOpen":false},{"id":"def-server.ActionParamsType","type":"Type","label":"ActionParamsType","description":[],"source":{"path":"x-pack/plugins/actions/server/builtin_action_types/server_log.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/server_log.ts#L25"},"signature":["{ readonly message: string; readonly level: \"info\" | \"error\" | \"debug\" | \"trace\" | \"warn\" | \"fatal\"; }"],"initialIsOpen":false},{"id":"def-server.ActionTypeId","type":"string","label":"ActionTypeId","description":[],"source":{"path":"x-pack/plugins/actions/server/builtin_action_types/slack.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/slack.ts#L54"},"signature":["\".slack\""],"initialIsOpen":false},{"id":"def-server.ActionParamsType","type":"Type","label":"ActionParamsType","description":[],"source":{"path":"x-pack/plugins/actions/server/builtin_action_types/slack.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/slack.ts#L46"},"signature":["{ readonly message: string; }"],"initialIsOpen":false},{"id":"def-server.ActionTypeId","type":"string","label":"ActionTypeId","description":[],"source":{"path":"x-pack/plugins/actions/server/builtin_action_types/webhook.ts","lineNumber":76,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/webhook.ts#L76"},"signature":["\".webhook\""],"initialIsOpen":false},{"id":"def-server.ActionParamsType","type":"Type","label":"ActionParamsType","description":[],"source":{"path":"x-pack/plugins/actions/server/builtin_action_types/webhook.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/webhook.ts#L71"},"signature":["{ readonly body?: string | undefined; }"],"initialIsOpen":false},{"id":"def-server.ServiceNowITSMActionTypeId","type":"string","label":"ServiceNowITSMActionTypeId","description":[],"source":{"path":"x-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts#L47"},"signature":["\".servicenow\""],"initialIsOpen":false},{"id":"def-server.ServiceNowSIRActionTypeId","type":"string","label":"ServiceNowSIRActionTypeId","description":[],"source":{"path":"x-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts#L48"},"signature":["\".servicenow-sir\""],"initialIsOpen":false},{"id":"def-server.ActionParamsType","type":"Type","label":"ActionParamsType","description":[],"source":{"path":"x-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/servicenow/index.ts#L35"},"signature":["Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; category: string | null; severity: string | null; externalId: string | null; urgency: string | null; impact: string | null; short_description: string; subcategory: string | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"getChoices\"; subActionParams: Readonly<{} & { fields: string[]; }>; }> | Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; category: string | null; externalId: string | null; short_description: string; subcategory: string | null; dest_ip: string | null; malware_hash: string | null; malware_url: string | null; source_ip: string | null; priority: string | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"getChoices\"; subActionParams: Readonly<{} & { fields: string[]; }>; }>"],"initialIsOpen":false},{"id":"def-server.ActionTypeId","type":"string","label":"ActionTypeId","description":[],"source":{"path":"x-pack/plugins/actions/server/builtin_action_types/jira/index.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/jira/index.ts#L52"},"signature":["\".jira\""],"initialIsOpen":false},{"id":"def-server.ActionParamsType","type":"Type","label":"ActionParamsType","description":[],"source":{"path":"x-pack/plugins/actions/server/builtin_action_types/jira/index.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/jira/index.ts#L36"},"signature":["Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; parent: string | null; summary: string; externalId: string | null; priority: string | null; issueType: string | null; labels: string[] | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"issueTypes\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"fieldsByIssueType\"; subActionParams: Readonly<{} & { id: string; }>; }> | Readonly<{} & { subAction: \"issues\"; subActionParams: Readonly<{} & { title: string; }>; }> | Readonly<{} & { subAction: \"issue\"; subActionParams: Readonly<{} & { id: string; }>; }>"],"initialIsOpen":false},{"id":"def-server.ActionTypeId","type":"string","label":"ActionTypeId","description":[],"source":{"path":"x-pack/plugins/actions/server/builtin_action_types/resilient/index.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/resilient/index.ts#L43"},"signature":["\".resilient\""],"initialIsOpen":false},{"id":"def-server.ActionParamsType","type":"Type","label":"ActionParamsType","description":[],"source":{"path":"x-pack/plugins/actions/server/builtin_action_types/resilient/index.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/resilient/index.ts#L34"},"signature":["Readonly<{} & { subAction: \"getFields\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"getIncident\"; subActionParams: Readonly<{} & { externalId: string; }>; }> | Readonly<{} & { subAction: \"handshake\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"pushToService\"; subActionParams: Readonly<{} & { incident: Readonly<{} & { description: string | null; name: string; externalId: string | null; incidentTypes: number[] | null; severityCode: number | null; }>; comments: Readonly<{} & { comment: string; commentId: string; }>[] | null; }>; }> | Readonly<{} & { subAction: \"incidentTypes\"; subActionParams: Readonly<{} & {}>; }> | Readonly<{} & { subAction: \"severity\"; subActionParams: Readonly<{} & {}>; }>"],"initialIsOpen":false},{"id":"def-server.ActionTypeId","type":"string","label":"ActionTypeId","description":[],"source":{"path":"x-pack/plugins/actions/server/builtin_action_types/teams.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/teams.ts#L46"},"signature":["\".teams\""],"initialIsOpen":false},{"id":"def-server.ActionParamsType","type":"Type","label":"ActionParamsType","description":[],"source":{"path":"x-pack/plugins/actions/server/builtin_action_types/teams.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/builtin_action_types/teams.ts#L40"},"signature":["{ readonly message: string; }"],"initialIsOpen":false}],"objects":[],"setup":{"id":"def-server.PluginSetupContract","type":"Interface","label":"PluginSetupContract","description":[],"children":[{"id":"def-server.PluginSetupContract.registerType","type":"Function","label":"registerType","signature":[" = Record, Secrets extends Record = Record, Params extends Record = Record, ExecutorResultData = void>(actionType: ",{"pluginId":"actions","scope":"server","docId":"kibActionsPluginApi","section":"def-server.ActionType","text":"ActionType"},") => void"],"description":[],"children":[{"type":"Object","label":"actionType","isRequired":true,"signature":[{"pluginId":"actions","scope":"server","docId":"kibActionsPluginApi","section":"def-server.ActionType","text":"ActionType"},""],"description":[],"source":{"path":"x-pack/plugins/actions/server/plugin.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L94"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/actions/server/plugin.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L88"}}],"source":{"path":"x-pack/plugins/actions/server/plugin.ts","lineNumber":87,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L87"},"lifecycle":"setup","initialIsOpen":true},"start":{"id":"def-server.PluginStartContract","type":"Interface","label":"PluginStartContract","description":[],"children":[{"id":"def-server.PluginStartContract.isActionTypeEnabled","type":"Function","label":"isActionTypeEnabled","signature":["(id: string, options?: { notifyUsage: boolean; } | undefined) => boolean"],"description":[],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/actions/server/plugin.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L99"}},{"id":"def-server.PluginStartContract.isActionTypeEnabled.options","type":"Object","label":"options","description":[],"children":[{"id":"def-server.PluginStartContract.isActionTypeEnabled.options.notifyUsage","type":"boolean","label":"notifyUsage","description":[],"source":{"path":"x-pack/plugins/actions/server/plugin.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L99"}}],"source":{"path":"x-pack/plugins/actions/server/plugin.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L99"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/actions/server/plugin.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L99"}},{"id":"def-server.PluginStartContract.isActionExecutable","type":"Function","label":"isActionExecutable","signature":["(actionId: string, actionTypeId: string, options?: { notifyUsage: boolean; } | undefined) => boolean"],"description":[],"children":[{"type":"string","label":"actionId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/actions/server/plugin.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L101"}},{"type":"string","label":"actionTypeId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/actions/server/plugin.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L102"}},{"id":"def-server.PluginStartContract.isActionExecutable.options","type":"Object","label":"options","description":[],"children":[{"id":"def-server.PluginStartContract.isActionExecutable.options.notifyUsage","type":"boolean","label":"notifyUsage","description":[],"source":{"path":"x-pack/plugins/actions/server/plugin.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L103"}}],"source":{"path":"x-pack/plugins/actions/server/plugin.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L103"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/actions/server/plugin.ts","lineNumber":100,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L100"}},{"id":"def-server.PluginStartContract.getActionsClientWithRequest","type":"Function","label":"getActionsClientWithRequest","signature":["(request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},") => Promise>"],"description":[],"children":[{"type":"Object","label":"request","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},""],"description":[],"source":{"path":"x-pack/plugins/actions/server/plugin.ts","lineNumber":105,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L105"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/actions/server/plugin.ts","lineNumber":105,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L105"}},{"id":"def-server.PluginStartContract.getActionsAuthorizationWithRequest","type":"Function","label":"getActionsAuthorizationWithRequest","signature":["(request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},") => Pick<",{"pluginId":"actions","scope":"server","docId":"kibActionsPluginApi","section":"def-server.ActionsAuthorization","text":"ActionsAuthorization"},", \"ensureAuthorized\">"],"description":[],"children":[{"type":"Object","label":"request","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},""],"description":[],"source":{"path":"x-pack/plugins/actions/server/plugin.ts","lineNumber":106,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L106"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/actions/server/plugin.ts","lineNumber":106,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L106"}},{"id":"def-server.PluginStartContract.preconfiguredActions","type":"Array","label":"preconfiguredActions","description":[],"source":{"path":"x-pack/plugins/actions/server/plugin.ts","lineNumber":107,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L107"},"signature":[{"pluginId":"actions","scope":"server","docId":"kibActionsPluginApi","section":"def-server.PreConfiguredAction","text":"PreConfiguredAction"},", Record>[]"]},{"id":"def-server.PluginStartContract.renderActionParameterTemplates","type":"Function","label":"renderActionParameterTemplates","signature":[" = Record>(actionTypeId: string, params: Params, variables: Record) => Params"],"description":[],"children":[{"type":"string","label":"actionTypeId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/actions/server/plugin.ts","lineNumber":109,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L109"}},{"type":"Uncategorized","label":"params","isRequired":true,"signature":["Params"],"description":[],"source":{"path":"x-pack/plugins/actions/server/plugin.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L110"}},{"type":"Object","label":"variables","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"x-pack/plugins/actions/server/plugin.ts","lineNumber":111,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L111"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/actions/server/plugin.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L108"}}],"source":{"path":"x-pack/plugins/actions/server/plugin.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/server/plugin.ts#L98"},"lifecycle":"start","initialIsOpen":true}},"common":{"classes":[],"functions":[{"id":"def-common.isActionTypeExecutorResult","type":"Function","label":"isActionTypeExecutorResult","signature":["(result: unknown) => boolean"],"description":[],"children":[{"type":"Unknown","label":"result","isRequired":true,"signature":["unknown"],"description":[],"source":{"path":"x-pack/plugins/actions/common/types.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L43"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/actions/common/types.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L42"},"initialIsOpen":false}],"interfaces":[{"id":"def-common.ActionType","type":"Interface","label":"ActionType","description":[],"children":[{"id":"def-common.ActionType.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/actions/common/types.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L11"}},{"id":"def-common.ActionType.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/actions/common/types.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L12"}},{"id":"def-common.ActionType.enabled","type":"boolean","label":"enabled","description":[],"source":{"path":"x-pack/plugins/actions/common/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L13"}},{"id":"def-common.ActionType.enabledInConfig","type":"boolean","label":"enabledInConfig","description":[],"source":{"path":"x-pack/plugins/actions/common/types.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L14"}},{"id":"def-common.ActionType.enabledInLicense","type":"boolean","label":"enabledInLicense","description":[],"source":{"path":"x-pack/plugins/actions/common/types.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L15"}},{"id":"def-common.ActionType.minimumLicenseRequired","type":"CompoundType","label":"minimumLicenseRequired","description":[],"source":{"path":"x-pack/plugins/actions/common/types.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L16"},"signature":["\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""]}],"source":{"path":"x-pack/plugins/actions/common/types.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L10"},"initialIsOpen":false},{"id":"def-common.ActionResult","type":"Interface","label":"ActionResult","description":[],"children":[{"id":"def-common.ActionResult.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/actions/common/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L20"}},{"id":"def-common.ActionResult.actionTypeId","type":"string","label":"actionTypeId","description":[],"source":{"path":"x-pack/plugins/actions/common/types.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L21"}},{"id":"def-common.ActionResult.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/actions/common/types.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L22"}},{"id":"def-common.ActionResult.config","type":"Object","label":"config","description":[],"source":{"path":"x-pack/plugins/actions/common/types.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L25"},"signature":["Record"]},{"id":"def-common.ActionResult.isPreconfigured","type":"boolean","label":"isPreconfigured","description":[],"source":{"path":"x-pack/plugins/actions/common/types.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L26"}}],"source":{"path":"x-pack/plugins/actions/common/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L19"},"initialIsOpen":false},{"id":"def-common.ActionTypeExecutorResult","type":"Interface","label":"ActionTypeExecutorResult","signature":[{"pluginId":"actions","scope":"common","docId":"kibActionsPluginApi","section":"def-common.ActionTypeExecutorResult","text":"ActionTypeExecutorResult"},""],"description":[],"children":[{"id":"def-common.ActionTypeExecutorResult.actionId","type":"string","label":"actionId","description":[],"source":{"path":"x-pack/plugins/actions/common/types.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L34"}},{"id":"def-common.ActionTypeExecutorResult.status","type":"CompoundType","label":"status","description":[],"source":{"path":"x-pack/plugins/actions/common/types.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L35"},"signature":["\"error\" | \"ok\""]},{"id":"def-common.ActionTypeExecutorResult.message","type":"string","label":"message","description":[],"source":{"path":"x-pack/plugins/actions/common/types.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L36"},"signature":["string | undefined"]},{"id":"def-common.ActionTypeExecutorResult.serviceMessage","type":"string","label":"serviceMessage","description":[],"source":{"path":"x-pack/plugins/actions/common/types.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L37"},"signature":["string | undefined"]},{"id":"def-common.ActionTypeExecutorResult.data","type":"Uncategorized","label":"data","description":[],"source":{"path":"x-pack/plugins/actions/common/types.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L38"},"signature":["Data | undefined"]},{"id":"def-common.ActionTypeExecutorResult.retry","type":"CompoundType","label":"retry","description":[],"source":{"path":"x-pack/plugins/actions/common/types.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L39"},"signature":["boolean | Date | null | undefined"]}],"source":{"path":"x-pack/plugins/actions/common/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/types.ts#L33"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-common.BASE_ACTION_API_PATH","type":"string","label":"BASE_ACTION_API_PATH","description":[],"source":{"path":"x-pack/plugins/actions/common/index.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/actions/common/index.ts#L10"},"signature":["\"/api/actions\""],"initialIsOpen":false}],"objects":[]}} \ No newline at end of file diff --git a/api_docs/actions.mdx b/api_docs/actions.mdx new file mode 100644 index 0000000000000..e723a9fccd20e --- /dev/null +++ b/api_docs/actions.mdx @@ -0,0 +1,32 @@ +--- +id: kibActionsPluginApi +slug: /kibana-dev-docs/actionsPluginApi +title: actions +image: https://source.unsplash.com/400x175/?github +summary: API docs for the actions plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'actions'] +--- + +import actionsObj from './actions.json'; + +## Server + +### Setup + +### Start + +### Functions + +### Interfaces + +### Consts, variables and types + +## Common + +### Functions + +### Interfaces + +### Consts, variables and types + diff --git a/api_docs/advanced_settings.json b/api_docs/advanced_settings.json new file mode 100644 index 0000000000000..294082f4deeb8 --- /dev/null +++ b/api_docs/advanced_settings.json @@ -0,0 +1 @@ +{"id":"advancedSettings","client":{"classes":[{"id":"def-public.ComponentRegistry","type":"Class","label":"ComponentRegistry","description":[],"children":[{"id":"def-public.ComponentRegistry.componentType","type":"Object","label":"componentType","description":[],"source":{"path":"src/plugins/advanced_settings/public/component_registry/component_registry.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L28"},"signature":["{ [key: string]: Id; }"]},{"id":"def-public.ComponentRegistry.defaultRegistry","type":"Object","children":[{"id":"def-public.ComponentRegistry.defaultRegistry.advanced_settings_page_title","type":"Function","label":"advanced_settings_page_title","description":[],"source":{"path":"src/plugins/advanced_settings/public/component_registry/component_registry.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L30"},"signature":["() => JSX.Element"]},{"id":"def-public.ComponentRegistry.defaultRegistry.advanced_settings_page_subtitle","type":"Function","label":"advanced_settings_page_subtitle","description":[],"source":{"path":"src/plugins/advanced_settings/public/component_registry/component_registry.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L31"},"signature":["() => null"]},{"id":"def-public.ComponentRegistry.defaultRegistry.advanced_settings_page_footer","type":"Function","label":"advanced_settings_page_footer","description":[],"source":{"path":"src/plugins/advanced_settings/public/component_registry/component_registry.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L32"},"signature":["() => null"]}],"description":[],"label":"defaultRegistry","source":{"path":"src/plugins/advanced_settings/public/component_registry/component_registry.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L29"}},{"id":"def-public.ComponentRegistry.registry","type":"Object","children":[],"description":[],"label":"registry","source":{"path":"src/plugins/advanced_settings/public/component_registry/component_registry.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L35"}},{"id":"def-public.ComponentRegistry.setup","type":"Object","children":[{"id":"def-public.ComponentRegistry.setup.componentType","type":"Object","label":"componentType","description":[],"source":{"path":"src/plugins/advanced_settings/public/component_registry/component_registry.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L72"},"signature":["{ [key: string]: Id; }"]},{"id":"def-public.ComponentRegistry.setup.register","type":"Function","label":"register","description":[],"source":{"path":"src/plugins/advanced_settings/public/component_registry/component_registry.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L73"},"signature":["(id: Id, component: React.ComponentType | undefined>, allowOverride?: boolean) => void"]}],"description":[],"label":"setup","source":{"path":"src/plugins/advanced_settings/public/component_registry/component_registry.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L71"}},{"id":"def-public.ComponentRegistry.start","type":"Object","children":[{"id":"def-public.ComponentRegistry.start.componentType","type":"Object","label":"componentType","description":[],"source":{"path":"src/plugins/advanced_settings/public/component_registry/component_registry.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L77"},"signature":["{ [key: string]: Id; }"]},{"id":"def-public.ComponentRegistry.start.get","type":"Function","label":"get","description":[],"source":{"path":"src/plugins/advanced_settings/public/component_registry/component_registry.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L78"},"signature":["(id: Id) => React.ComponentType | undefined>"]}],"description":[],"label":"start","source":{"path":"src/plugins/advanced_settings/public/component_registry/component_registry.ts","lineNumber":76,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L76"}}],"source":{"path":"src/plugins/advanced_settings/public/component_registry/component_registry.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L27"},"initialIsOpen":false}],"functions":[{"id":"def-public.LazyField","type":"Function","label":"LazyField","description":["\nExports the field component as a React.lazy component. We're explicitly naming it lazy here\nso any plugin that would import that can clearly see it's lazy loaded and can only be used\ninside a suspense context."],"source":{"path":"src/plugins/advanced_settings/public/index.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/index.ts#L20"},"signature":["React.LazyExoticComponent"],"initialIsOpen":false}],"interfaces":[],"enums":[],"misc":[],"objects":[],"setup":{"id":"def-public.AdvancedSettingsSetup","type":"Interface","label":"AdvancedSettingsSetup","description":[],"children":[{"id":"def-public.AdvancedSettingsSetup.component","type":"Object","label":"component","description":[],"source":{"path":"src/plugins/advanced_settings/public/types.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/types.ts#L16"},"signature":["{ componentType: { [key: string]: Id; }; register: (id: Id, component: React.ComponentType | undefined>, allowOverride?: boolean) => void; }"]}],"source":{"path":"src/plugins/advanced_settings/public/types.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/types.ts#L15"},"lifecycle":"setup","initialIsOpen":true},"start":{"id":"def-public.AdvancedSettingsStart","type":"Interface","label":"AdvancedSettingsStart","description":[],"children":[{"id":"def-public.AdvancedSettingsStart.component","type":"Object","label":"component","description":[],"source":{"path":"src/plugins/advanced_settings/public/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/types.ts#L19"},"signature":["{ componentType: { [key: string]: Id; }; get: (id: Id) => React.ComponentType | undefined>; }"]}],"source":{"path":"src/plugins/advanced_settings/public/types.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/types.ts#L18"},"lifecycle":"start","initialIsOpen":true}},"server":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]}} \ No newline at end of file diff --git a/api_docs/advanced_settings.mdx b/api_docs/advanced_settings.mdx new file mode 100644 index 0000000000000..f2f480c1faca2 --- /dev/null +++ b/api_docs/advanced_settings.mdx @@ -0,0 +1,22 @@ +--- +id: kibAdvancedSettingsPluginApi +slug: /kibana-dev-docs/advancedSettingsPluginApi +title: advancedSettings +image: https://source.unsplash.com/400x175/?github +summary: API docs for the advancedSettings plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'advancedSettings'] +--- + +import advancedSettingsObj from './advanced_settings.json'; + +## Client + +### Setup + +### Start + +### Functions + +### Classes + diff --git a/api_docs/alerts.json b/api_docs/alerts.json new file mode 100644 index 0000000000000..b466b674a484c --- /dev/null +++ b/api_docs/alerts.json @@ -0,0 +1 @@ +{"id":"alerts","client":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[],"setup":{"id":"def-public.PluginSetupContract","type":"Interface","label":"PluginSetupContract","description":[],"children":[{"id":"def-public.PluginSetupContract.registerNavigation","type":"Function","label":"registerNavigation","description":[],"source":{"path":"x-pack/plugins/alerts/public/plugin.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/public/plugin.ts#L15"},"signature":["(consumer: string, alertType: string, handler: ",{"pluginId":"alerts","scope":"public","docId":"kibAlertsPluginApi","section":"def-public.AlertNavigationHandler","text":"AlertNavigationHandler"},") => void"]},{"id":"def-public.PluginSetupContract.registerDefaultNavigation","type":"Function","label":"registerDefaultNavigation","description":[],"source":{"path":"x-pack/plugins/alerts/public/plugin.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/public/plugin.ts#L20"},"signature":["(consumer: string, handler: ",{"pluginId":"alerts","scope":"public","docId":"kibAlertsPluginApi","section":"def-public.AlertNavigationHandler","text":"AlertNavigationHandler"},") => void"]}],"source":{"path":"x-pack/plugins/alerts/public/plugin.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/public/plugin.ts#L14"},"lifecycle":"setup","initialIsOpen":true},"start":{"id":"def-public.PluginStartContract","type":"Interface","label":"PluginStartContract","description":[],"children":[{"id":"def-public.PluginStartContract.getNavigation","type":"Function","label":"getNavigation","description":[],"source":{"path":"x-pack/plugins/alerts/public/plugin.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/public/plugin.ts#L23"},"signature":["(alertId: string) => Promise<",{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.AlertUrlNavigation","text":"AlertUrlNavigation"}," | ",{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.AlertStateNavigation","text":"AlertStateNavigation"}," | undefined>"]}],"source":{"path":"x-pack/plugins/alerts/public/plugin.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/public/plugin.ts#L22"},"lifecycle":"start","initialIsOpen":true}},"server":{"classes":[],"functions":[{"id":"def-server.parseDuration","type":"Function","label":"parseDuration","signature":["(duration: string) => number"],"description":[],"children":[{"type":"string","label":"duration","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/alerts/common/parse_duration.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/parse_duration.ts#L14"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/alerts/common/parse_duration.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/parse_duration.ts#L14"},"initialIsOpen":false}],"interfaces":[{"id":"def-server.ActionVariable","type":"Interface","label":"ActionVariable","description":[],"children":[{"id":"def-server.ActionVariable.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":106,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L106"}},{"id":"def-server.ActionVariable.description","type":"string","label":"description","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":107,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L107"}},{"id":"def-server.ActionVariable.useWithTripleBracesInTemplates","type":"CompoundType","label":"useWithTripleBracesInTemplates","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L108"},"signature":["boolean | undefined"]}],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":105,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L105"},"initialIsOpen":false},{"id":"def-server.AlertType","type":"Interface","label":"AlertType","signature":[{"pluginId":"alerts","scope":"server","docId":"kibAlertsPluginApi","section":"def-server.AlertType","text":"AlertType"},""],"description":[],"children":[{"id":"def-server.AlertType.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":132,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L132"}},{"id":"def-server.AlertType.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":133,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L133"}},{"id":"def-server.AlertType.validate","type":"Object","label":"validate","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":134,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L134"},"signature":["{ params?: ",{"pluginId":"alerts","scope":"server","docId":"kibAlertsPluginApi","section":"def-server.AlertTypeParamsValidator","text":"AlertTypeParamsValidator"}," | undefined; } | undefined"]},{"id":"def-server.AlertType.actionGroups","type":"Array","label":"actionGroups","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":137,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L137"},"signature":[{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.ActionGroup","text":"ActionGroup"},"[]"]},{"id":"def-server.AlertType.defaultActionGroupId","type":"Uncategorized","label":"defaultActionGroupId","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":138,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L138"},"signature":["ActionGroupIds"]},{"id":"def-server.AlertType.recoveryActionGroup","type":"Object","label":"recoveryActionGroup","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":139,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L139"},"signature":[{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.ActionGroup","text":"ActionGroup"}," | undefined"]},{"id":"def-server.AlertType.executor","type":"Function","label":"executor","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":140,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L140"},"signature":[{"pluginId":"alerts","scope":"server","docId":"kibAlertsPluginApi","section":"def-server.ExecutorType","text":"ExecutorType"},">"]},{"id":"def-server.AlertType.producer","type":"string","label":"producer","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":151,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L151"}},{"id":"def-server.AlertType.actionVariables","type":"Object","label":"actionVariables","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":152,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L152"},"signature":["{ context?: ",{"pluginId":"alerts","scope":"server","docId":"kibAlertsPluginApi","section":"def-server.ActionVariable","text":"ActionVariable"},"[] | undefined; state?: ",{"pluginId":"alerts","scope":"server","docId":"kibAlertsPluginApi","section":"def-server.ActionVariable","text":"ActionVariable"},"[] | undefined; params?: ",{"pluginId":"alerts","scope":"server","docId":"kibAlertsPluginApi","section":"def-server.ActionVariable","text":"ActionVariable"},"[] | undefined; } | undefined"]},{"id":"def-server.AlertType.minimumLicenseRequired","type":"CompoundType","label":"minimumLicenseRequired","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":157,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L157"},"signature":["\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""]}],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":124,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L124"},"initialIsOpen":false},{"id":"def-server.ActionGroup","type":"Interface","label":"ActionGroup","signature":[{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.ActionGroup","text":"ActionGroup"},""],"description":[],"children":[{"id":"def-server.ActionGroup.id","type":"Uncategorized","label":"id","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_type.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L26"},"signature":["ActionGroupIds"]},{"id":"def-server.ActionGroup.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_type.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L27"}}],"source":{"path":"x-pack/plugins/alerts/common/alert_type.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L25"},"initialIsOpen":false},{"id":"def-server.AlertingPlugin","type":"Interface","label":"AlertingPlugin","description":[],"children":[{"id":"def-server.AlertingPlugin.setup","type":"Object","label":"setup","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":231,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L231"},"signature":[{"pluginId":"alerts","scope":"server","docId":"kibAlertsPluginApi","section":"def-server.PluginSetupContract","text":"PluginSetupContract"}]},{"id":"def-server.AlertingPlugin.start","type":"Object","label":"start","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":232,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L232"},"signature":[{"pluginId":"alerts","scope":"server","docId":"kibAlertsPluginApi","section":"def-server.PluginStartContract","text":"PluginStartContract"}]}],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":230,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L230"},"initialIsOpen":false},{"id":"def-server.AlertExecutorOptions","type":"Interface","label":"AlertExecutorOptions","signature":[{"pluginId":"alerts","scope":"server","docId":"kibAlertsPluginApi","section":"def-server.AlertExecutorOptions","text":"AlertExecutorOptions"},""],"description":[],"children":[{"id":"def-server.AlertExecutorOptions.alertId","type":"string","label":"alertId","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":91,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L91"}},{"id":"def-server.AlertExecutorOptions.startedAt","type":"Object","label":"startedAt","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L92"},"signature":["Date"]},{"id":"def-server.AlertExecutorOptions.previousStartedAt","type":"CompoundType","label":"previousStartedAt","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":93,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L93"},"signature":["Date | null"]},{"id":"def-server.AlertExecutorOptions.services","type":"Object","label":"services","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L94"},"signature":[{"pluginId":"alerts","scope":"server","docId":"kibAlertsPluginApi","section":"def-server.AlertServices","text":"AlertServices"},""]},{"id":"def-server.AlertExecutorOptions.params","type":"Uncategorized","label":"params","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L95"},"signature":["Params"]},{"id":"def-server.AlertExecutorOptions.state","type":"Uncategorized","label":"state","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L96"},"signature":["State"]},{"id":"def-server.AlertExecutorOptions.spaceId","type":"string","label":"spaceId","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L97"}},{"id":"def-server.AlertExecutorOptions.namespace","type":"string","label":"namespace","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L98"},"signature":["string | undefined"]},{"id":"def-server.AlertExecutorOptions.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L99"}},{"id":"def-server.AlertExecutorOptions.tags","type":"Array","label":"tags","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":100,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L100"},"signature":["string[]"]},{"id":"def-server.AlertExecutorOptions.createdBy","type":"CompoundType","label":"createdBy","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L101"},"signature":["string | null"]},{"id":"def-server.AlertExecutorOptions.updatedBy","type":"CompoundType","label":"updatedBy","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L102"},"signature":["string | null"]}],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L84"},"initialIsOpen":false},{"id":"def-server.AlertServices","type":"Interface","label":"AlertServices","signature":[{"pluginId":"alerts","scope":"server","docId":"kibAlertsPluginApi","section":"def-server.AlertServices","text":"AlertServices"}," extends ","Services"],"description":[],"children":[{"id":"def-server.AlertServices.alertInstanceFactory","type":"Function","label":"alertInstanceFactory","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L79"},"signature":["(id: string) => Pick<",{"pluginId":"alerts","scope":"server","docId":"kibAlertsPluginApi","section":"def-server.AlertInstance","text":"AlertInstance"},", \"getState\" | \"replaceState\" | \"scheduleActions\" | \"scheduleActionsWithSubGroup\">"]}],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L74"},"initialIsOpen":false},{"id":"def-server.AlertingApiRequestHandlerContext","type":"Interface","label":"AlertingApiRequestHandlerContext","description":[],"children":[{"id":"def-server.AlertingApiRequestHandlerContext.getAlertsClient","type":"Function","label":"getAlertsClient","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L47"},"signature":["() => ",{"pluginId":"alerts","scope":"server","docId":"kibAlertsPluginApi","section":"def-server.AlertsClient","text":"AlertsClient"}]},{"id":"def-server.AlertingApiRequestHandlerContext.listTypes","type":"Function","label":"listTypes","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L48"},"signature":["() => Set<",{"pluginId":"alerts","scope":"server","docId":"kibAlertsPluginApi","section":"def-server.RegistryAlertType","text":"RegistryAlertType"},">"]},{"id":"def-server.AlertingApiRequestHandlerContext.getFrameworkHealth","type":"Function","label":"getFrameworkHealth","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L49"},"signature":["() => Promise<",{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.AlertsHealth","text":"AlertsHealth"},">"]}],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L46"},"initialIsOpen":false},{"id":"def-server.PluginSetupContract","type":"Interface","label":"PluginSetupContract","description":[],"children":[{"id":"def-server.PluginSetupContract.registerType","type":"Function","label":"registerType","signature":[" = Record, State extends Record = Record, InstanceState extends { [x: string]: unknown; } = { [x: string]: unknown; }, InstanceContext extends { [x: string]: unknown; } = { [x: string]: unknown; }, ActionGroupIds extends string = never, RecoveryActionGroupId extends string = never>(alertType: ",{"pluginId":"alerts","scope":"server","docId":"kibAlertsPluginApi","section":"def-server.AlertType","text":"AlertType"},") => void"],"description":[],"children":[{"type":"Object","label":"alertType","isRequired":true,"signature":[{"pluginId":"alerts","scope":"server","docId":"kibAlertsPluginApi","section":"def-server.AlertType","text":"AlertType"},""],"description":[],"source":{"path":"x-pack/plugins/alerts/server/plugin.ts","lineNumber":112,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/plugin.ts#L112"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/alerts/server/plugin.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/plugin.ts#L104"}}],"source":{"path":"x-pack/plugins/alerts/server/plugin.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/plugin.ts#L103"},"initialIsOpen":false},{"id":"def-server.PluginStartContract","type":"Interface","label":"PluginStartContract","description":[],"children":[{"id":"def-server.PluginStartContract.listTypes","type":"Function","label":"listTypes","description":[],"source":{"path":"x-pack/plugins/alerts/server/plugin.ts","lineNumber":124,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/plugin.ts#L124"},"signature":["() => Set<",{"pluginId":"alerts","scope":"server","docId":"kibAlertsPluginApi","section":"def-server.RegistryAlertType","text":"RegistryAlertType"},">"]},{"id":"def-server.PluginStartContract.getAlertsClientWithRequest","type":"Function","label":"getAlertsClientWithRequest","signature":["(request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},") => Pick<",{"pluginId":"alerts","scope":"server","docId":"kibAlertsPluginApi","section":"def-server.AlertsClient","text":"AlertsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"aggregate\" | \"enable\" | \"disable\" | \"getAlertState\" | \"getAlertInstanceSummary\" | \"updateApiKey\" | \"muteAll\" | \"unmuteAll\" | \"muteInstance\" | \"unmuteInstance\" | \"listAlertTypes\">"],"description":[],"children":[{"type":"Object","label":"request","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},""],"description":[],"source":{"path":"x-pack/plugins/alerts/server/plugin.ts","lineNumber":125,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/plugin.ts#L125"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/alerts/server/plugin.ts","lineNumber":125,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/plugin.ts#L125"}},{"id":"def-server.PluginStartContract.getFrameworkHealth","type":"Function","label":"getFrameworkHealth","description":[],"source":{"path":"x-pack/plugins/alerts/server/plugin.ts","lineNumber":126,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/plugin.ts#L126"},"signature":["() => Promise<",{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.AlertsHealth","text":"AlertsHealth"},">"]}],"source":{"path":"x-pack/plugins/alerts/server/plugin.ts","lineNumber":123,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/plugin.ts#L123"},"initialIsOpen":false},{"id":"def-server.FindResult","type":"Interface","label":"FindResult","signature":[{"pluginId":"alerts","scope":"server","docId":"kibAlertsPluginApi","section":"def-server.FindResult","text":"FindResult"},""],"description":[],"children":[{"id":"def-server.FindResult.page","type":"number","label":"page","description":[],"source":{"path":"x-pack/plugins/alerts/server/alerts_client/alerts_client.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/alerts_client/alerts_client.ts#L131"}},{"id":"def-server.FindResult.perPage","type":"number","label":"perPage","description":[],"source":{"path":"x-pack/plugins/alerts/server/alerts_client/alerts_client.ts","lineNumber":132,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/alerts_client/alerts_client.ts#L132"}},{"id":"def-server.FindResult.total","type":"number","label":"total","description":[],"source":{"path":"x-pack/plugins/alerts/server/alerts_client/alerts_client.ts","lineNumber":133,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/alerts_client/alerts_client.ts#L133"}},{"id":"def-server.FindResult.data","type":"Array","label":"data","description":[],"source":{"path":"x-pack/plugins/alerts/server/alerts_client/alerts_client.ts","lineNumber":134,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/alerts_client/alerts_client.ts#L134"},"signature":["Pick<",{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.Alert","text":"Alert"},", \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"muteAll\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">[]"]}],"source":{"path":"x-pack/plugins/alerts/server/alerts_client/alerts_client.ts","lineNumber":130,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/alerts_client/alerts_client.ts#L130"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-server.AlertsClient","type":"Type","label":"AlertsClient","description":[],"source":{"path":"x-pack/plugins/alerts/server/index.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/index.ts#L15"},"signature":["{ get: ({ id, }: { id: string; }) => Promise, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"muteAll\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>; delete: ({ id }: { id: string; }) => Promise<{}>; create: = never>({ data, options, }: ","CreateOptions",") => Promise<",{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.Alert","text":"Alert"},">; find: ({ options: { fields, ...options }, }?: { options?: ","FindOptions"," | undefined; }) => Promise<",{"pluginId":"alerts","scope":"server","docId":"kibAlertsPluginApi","section":"def-server.FindResult","text":"FindResult"}],"initialIsOpen":false},{"id":"def-server.ActionGroupIdsOf","type":"Type","label":"ActionGroupIdsOf","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_type.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L30"},"signature":["T extends ActionGroup ? groups : T extends Readonly> ? groups : never"],"initialIsOpen":false},{"id":"def-server.AlertActionParams","type":"Type","label":"AlertActionParams","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L40"},"signature":["SavedObjectAttributes"],"initialIsOpen":false},{"id":"def-server.AlertTypeState","type":"Type","label":"AlertTypeState","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L11"},"signature":["{ [x: string]: unknown; }"],"initialIsOpen":false},{"id":"def-server.AlertTypeParams","type":"Type","label":"AlertTypeParams","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L12"},"signature":["{ [x: string]: unknown; }"],"initialIsOpen":false},{"id":"def-server.PartialAlert","type":"Type","label":"PartialAlert","description":[],"source":{"path":"x-pack/plugins/alerts/server/types.ts","lineNumber":190,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/types.ts#L190"},"signature":["Pick, \"id\"> & Partial, \"enabled\" | \"name\" | \"params\" | \"actions\" | \"muteAll\" | \"apiKey\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>"],"initialIsOpen":false},{"id":"def-server.AlertInstanceState","type":"Type","label":"AlertInstanceState","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_instance.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance.ts#L25"},"signature":["{ [x: string]: unknown; }"],"initialIsOpen":false},{"id":"def-server.AlertInstanceContext","type":"Type","label":"AlertInstanceContext","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_instance.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance.ts#L28"},"signature":["{ [x: string]: unknown; }"],"initialIsOpen":false},{"id":"def-server.PublicAlertInstance","type":"Type","label":"PublicAlertInstance","description":[],"source":{"path":"x-pack/plugins/alerts/server/alert_instance/alert_instance.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/server/alert_instance/alert_instance.ts#L30"},"signature":["{ getState: () => State; replaceState: (state: State) => AlertInstance; scheduleActions: (actionGroup: ActionGroupIds, context?: Context) => AlertInstance; scheduleActionsWithSubGroup: (actionGroup: ActionGroupIds, subgroup: string, context?: Context) => AlertInstance; }"],"initialIsOpen":false}],"objects":[]},"common":{"classes":[],"functions":[{"id":"def-common.getBuiltinActionGroups","type":"Function","label":"getBuiltinActionGroups","signature":["(customRecoveryGroup: ",{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.ActionGroup","text":"ActionGroup"}," | undefined) => [",{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.ActionGroup","text":"ActionGroup"},"<",{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.ReservedActionGroups","text":"ReservedActionGroups"},">]"],"description":[],"children":[{"type":"Object","label":"customRecoveryGroup","isRequired":false,"signature":[{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.ActionGroup","text":"ActionGroup"}," | undefined"],"description":[],"source":{"path":"x-pack/plugins/alerts/common/builtin_action_groups.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/builtin_action_groups.ts#L31"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/alerts/common/builtin_action_groups.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/builtin_action_groups.ts#L30"},"initialIsOpen":false},{"id":"def-common.isActionGroupDisabledForActionTypeId","type":"Function","label":"isActionGroupDisabledForActionTypeId","signature":["(actionGroup: string, actionTypeId: string) => boolean"],"description":[],"children":[{"type":"string","label":"actionGroup","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/alerts/common/disabled_action_groups.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/disabled_action_groups.ts#L19"}},{"type":"string","label":"actionTypeId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/alerts/common/disabled_action_groups.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/disabled_action_groups.ts#L20"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/alerts/common/disabled_action_groups.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/disabled_action_groups.ts#L18"},"initialIsOpen":false},{"id":"def-common.validateNotifyWhenType","type":"Function","label":"validateNotifyWhenType","signature":["(notifyWhen: string) => string | undefined"],"description":[],"children":[{"type":"string","label":"notifyWhen","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_notify_when_type.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_notify_when_type.ts#L15"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/alerts/common/alert_notify_when_type.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_notify_when_type.ts#L15"},"initialIsOpen":false},{"id":"def-common.parseDuration","type":"Function","label":"parseDuration","signature":["(duration: string) => number"],"description":[],"children":[{"type":"string","label":"duration","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/alerts/common/parse_duration.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/parse_duration.ts#L14"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/alerts/common/parse_duration.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/parse_duration.ts#L14"},"initialIsOpen":false},{"id":"def-common.getDurationNumberInItsUnit","type":"Function","label":"getDurationNumberInItsUnit","signature":["(duration: string) => number"],"description":[],"children":[{"type":"string","label":"duration","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/alerts/common/parse_duration.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/parse_duration.ts#L30"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/alerts/common/parse_duration.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/parse_duration.ts#L30"},"initialIsOpen":false},{"id":"def-common.getDurationUnitValue","type":"Function","label":"getDurationUnitValue","signature":["(duration: string) => string"],"description":[],"children":[{"type":"string","label":"duration","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/alerts/common/parse_duration.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/parse_duration.ts#L34"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/alerts/common/parse_duration.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/parse_duration.ts#L34"},"initialIsOpen":false},{"id":"def-common.validateDurationSchema","type":"Function","label":"validateDurationSchema","signature":["(duration: string) => string | undefined"],"description":[],"children":[{"type":"string","label":"duration","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/alerts/common/parse_duration.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/parse_duration.ts#L39"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/alerts/common/parse_duration.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/parse_duration.ts#L39"},"initialIsOpen":false}],"interfaces":[{"id":"def-common.AlertingFrameworkHealth","type":"Interface","label":"AlertingFrameworkHealth","description":[],"children":[{"id":"def-common.AlertingFrameworkHealth.isSufficientlySecure","type":"boolean","label":"isSufficientlySecure","description":[],"source":{"path":"x-pack/plugins/alerts/common/index.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/index.ts#L22"}},{"id":"def-common.AlertingFrameworkHealth.hasPermanentEncryptionKey","type":"boolean","label":"hasPermanentEncryptionKey","description":[],"source":{"path":"x-pack/plugins/alerts/common/index.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/index.ts#L23"}},{"id":"def-common.AlertingFrameworkHealth.alertingFrameworkHeath","type":"Object","label":"alertingFrameworkHeath","description":[],"source":{"path":"x-pack/plugins/alerts/common/index.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/index.ts#L24"},"signature":[{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.AlertsHealth","text":"AlertsHealth"}]}],"source":{"path":"x-pack/plugins/alerts/common/index.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/index.ts#L21"},"initialIsOpen":false},{"id":"def-common.IntervalSchedule","type":"Interface","label":"IntervalSchedule","signature":[{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.IntervalSchedule","text":"IntervalSchedule"}," extends ","SavedObjectAttributes"],"description":[],"children":[{"id":"def-common.IntervalSchedule.interval","type":"string","label":"interval","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L15"}}],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L14"},"initialIsOpen":false},{"id":"def-common.AlertExecutionStatus","type":"Interface","label":"AlertExecutionStatus","description":[],"children":[{"id":"def-common.AlertExecutionStatus.status","type":"CompoundType","label":"status","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L32"},"signature":["\"unknown\" | \"error\" | \"pending\" | \"ok\" | \"active\""]},{"id":"def-common.AlertExecutionStatus.lastExecutionDate","type":"Object","label":"lastExecutionDate","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L33"},"signature":["Date"]},{"id":"def-common.AlertExecutionStatus.error","type":"Object","label":"error","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L34"},"signature":["{ reason: ",{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.AlertExecutionStatusErrorReasons","text":"AlertExecutionStatusErrorReasons"},"; message: string; } | undefined"]}],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L31"},"initialIsOpen":false},{"id":"def-common.AlertAction","type":"Interface","label":"AlertAction","description":[],"children":[{"id":"def-common.AlertAction.group","type":"string","label":"group","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L44"}},{"id":"def-common.AlertAction.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L45"}},{"id":"def-common.AlertAction.actionTypeId","type":"string","label":"actionTypeId","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L46"}},{"id":"def-common.AlertAction.params","type":"Object","label":"params","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L47"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectAttributes","text":"SavedObjectAttributes"}]}],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L43"},"initialIsOpen":false},{"id":"def-common.AlertAggregations","type":"Interface","label":"AlertAggregations","description":[],"children":[{"id":"def-common.AlertAggregations.alertExecutionStatus","type":"Object","label":"alertExecutionStatus","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L51"},"signature":["{ [status: string]: number; }"]}],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L50"},"initialIsOpen":false},{"id":"def-common.Alert","type":"Interface","label":"Alert","signature":[{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.Alert","text":"Alert"},""],"description":[],"children":[{"id":"def-common.Alert.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L55"}},{"id":"def-common.Alert.enabled","type":"boolean","label":"enabled","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L56"}},{"id":"def-common.Alert.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L57"}},{"id":"def-common.Alert.tags","type":"Array","label":"tags","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L58"},"signature":["string[]"]},{"id":"def-common.Alert.alertTypeId","type":"string","label":"alertTypeId","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L59"}},{"id":"def-common.Alert.consumer","type":"string","label":"consumer","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L60"}},{"id":"def-common.Alert.schedule","type":"Object","label":"schedule","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L61"},"signature":[{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.IntervalSchedule","text":"IntervalSchedule"}]},{"id":"def-common.Alert.actions","type":"Array","label":"actions","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L62"},"signature":[{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.AlertAction","text":"AlertAction"},"[]"]},{"id":"def-common.Alert.params","type":"Uncategorized","label":"params","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L63"},"signature":["Params"]},{"id":"def-common.Alert.scheduledTaskId","type":"string","label":"scheduledTaskId","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L64"},"signature":["string | undefined"]},{"id":"def-common.Alert.createdBy","type":"CompoundType","label":"createdBy","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L65"},"signature":["string | null"]},{"id":"def-common.Alert.updatedBy","type":"CompoundType","label":"updatedBy","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L66"},"signature":["string | null"]},{"id":"def-common.Alert.createdAt","type":"Object","label":"createdAt","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L67"},"signature":["Date"]},{"id":"def-common.Alert.updatedAt","type":"Object","label":"updatedAt","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L68"},"signature":["Date"]},{"id":"def-common.Alert.apiKey","type":"CompoundType","label":"apiKey","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L69"},"signature":["string | null"]},{"id":"def-common.Alert.apiKeyOwner","type":"CompoundType","label":"apiKeyOwner","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L70"},"signature":["string | null"]},{"id":"def-common.Alert.throttle","type":"CompoundType","label":"throttle","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L71"},"signature":["string | null"]},{"id":"def-common.Alert.notifyWhen","type":"CompoundType","label":"notifyWhen","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L72"},"signature":["\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null"]},{"id":"def-common.Alert.muteAll","type":"boolean","label":"muteAll","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L73"}},{"id":"def-common.Alert.mutedInstanceIds","type":"Array","label":"mutedInstanceIds","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L74"},"signature":["string[]"]},{"id":"def-common.Alert.executionStatus","type":"Object","label":"executionStatus","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L75"},"signature":[{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.AlertExecutionStatus","text":"AlertExecutionStatus"}]}],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L54"},"initialIsOpen":false},{"id":"def-common.AlertsHealth","type":"Interface","label":"AlertsHealth","description":[],"children":[{"id":"def-common.AlertsHealth.decryptionHealth","type":"Object","label":"decryptionHealth","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":87,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L87"},"signature":["{ status: ",{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.HealthStatus","text":"HealthStatus"},"; timestamp: string; }"]},{"id":"def-common.AlertsHealth.executionHealth","type":"Object","label":"executionHealth","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":91,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L91"},"signature":["{ status: ",{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.HealthStatus","text":"HealthStatus"},"; timestamp: string; }"]},{"id":"def-common.AlertsHealth.readHealth","type":"Object","label":"readHealth","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L95"},"signature":["{ status: ",{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.HealthStatus","text":"HealthStatus"},"; timestamp: string; }"]}],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L86"},"initialIsOpen":false},{"id":"def-common.AlertType","type":"Interface","label":"AlertType","signature":[{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.AlertType","text":"AlertType"},""],"description":[],"children":[{"id":"def-common.AlertType.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_type.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L15"}},{"id":"def-common.AlertType.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_type.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L16"}},{"id":"def-common.AlertType.actionGroups","type":"Array","label":"actionGroups","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_type.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L17"},"signature":[{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.ActionGroup","text":"ActionGroup"},"[]"]},{"id":"def-common.AlertType.recoveryActionGroup","type":"Object","label":"recoveryActionGroup","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_type.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L18"},"signature":[{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.ActionGroup","text":"ActionGroup"},""]},{"id":"def-common.AlertType.actionVariables","type":"Array","label":"actionVariables","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_type.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L19"},"signature":["string[]"]},{"id":"def-common.AlertType.defaultActionGroupId","type":"Uncategorized","label":"defaultActionGroupId","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_type.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L20"},"signature":["ActionGroupIds"]},{"id":"def-common.AlertType.producer","type":"string","label":"producer","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_type.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L21"}},{"id":"def-common.AlertType.minimumLicenseRequired","type":"CompoundType","label":"minimumLicenseRequired","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_type.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L22"},"signature":["\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""]}],"source":{"path":"x-pack/plugins/alerts/common/alert_type.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L11"},"initialIsOpen":false},{"id":"def-common.ActionGroup","type":"Interface","label":"ActionGroup","signature":[{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.ActionGroup","text":"ActionGroup"},""],"description":[],"children":[{"id":"def-common.ActionGroup.id","type":"Uncategorized","label":"id","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_type.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L26"},"signature":["ActionGroupIds"]},{"id":"def-common.ActionGroup.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_type.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L27"}}],"source":{"path":"x-pack/plugins/alerts/common/alert_type.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L25"},"initialIsOpen":false},{"id":"def-common.AlertUrlNavigation","type":"Interface","label":"AlertUrlNavigation","description":[],"children":[{"id":"def-common.AlertUrlNavigation.path","type":"string","label":"path","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_navigation.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_navigation.ts#L11"}}],"source":{"path":"x-pack/plugins/alerts/common/alert_navigation.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_navigation.ts#L10"},"initialIsOpen":false},{"id":"def-common.AlertStateNavigation","type":"Interface","label":"AlertStateNavigation","description":[],"children":[{"id":"def-common.AlertStateNavigation.state","type":"Object","label":"state","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_navigation.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_navigation.ts#L14"},"signature":[{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.JsonObject","text":"JsonObject"}]}],"source":{"path":"x-pack/plugins/alerts/common/alert_navigation.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_navigation.ts#L13"},"initialIsOpen":false},{"id":"def-common.AlertInstanceSummary","type":"Interface","label":"AlertInstanceSummary","description":[],"children":[{"id":"def-common.AlertInstanceSummary.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_instance_summary.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L12"}},{"id":"def-common.AlertInstanceSummary.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_instance_summary.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L13"}},{"id":"def-common.AlertInstanceSummary.tags","type":"Array","label":"tags","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_instance_summary.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L14"},"signature":["string[]"]},{"id":"def-common.AlertInstanceSummary.alertTypeId","type":"string","label":"alertTypeId","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_instance_summary.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L15"}},{"id":"def-common.AlertInstanceSummary.consumer","type":"string","label":"consumer","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_instance_summary.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L16"}},{"id":"def-common.AlertInstanceSummary.muteAll","type":"boolean","label":"muteAll","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_instance_summary.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L17"}},{"id":"def-common.AlertInstanceSummary.throttle","type":"CompoundType","label":"throttle","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_instance_summary.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L18"},"signature":["string | null"]},{"id":"def-common.AlertInstanceSummary.enabled","type":"boolean","label":"enabled","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_instance_summary.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L19"}},{"id":"def-common.AlertInstanceSummary.statusStartDate","type":"string","label":"statusStartDate","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_instance_summary.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L20"}},{"id":"def-common.AlertInstanceSummary.statusEndDate","type":"string","label":"statusEndDate","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_instance_summary.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L21"}},{"id":"def-common.AlertInstanceSummary.status","type":"CompoundType","label":"status","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_instance_summary.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L22"},"signature":[{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.AlertStatusValues","text":"AlertStatusValues"}]},{"id":"def-common.AlertInstanceSummary.lastRun","type":"string","label":"lastRun","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_instance_summary.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L23"},"signature":["string | undefined"]},{"id":"def-common.AlertInstanceSummary.errorMessages","type":"Array","label":"errorMessages","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_instance_summary.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L24"},"signature":["{ date: string; message: string; }[]"]},{"id":"def-common.AlertInstanceSummary.instances","type":"Object","label":"instances","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_instance_summary.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L25"},"signature":["Record"]}],"source":{"path":"x-pack/plugins/alerts/common/alert_instance_summary.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L11"},"initialIsOpen":false},{"id":"def-common.AlertInstanceStatus","type":"Interface","label":"AlertInstanceStatus","description":[],"children":[{"id":"def-common.AlertInstanceStatus.status","type":"CompoundType","label":"status","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_instance_summary.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L29"},"signature":[{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.AlertInstanceStatusValues","text":"AlertInstanceStatusValues"}]},{"id":"def-common.AlertInstanceStatus.muted","type":"boolean","label":"muted","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_instance_summary.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L30"}},{"id":"def-common.AlertInstanceStatus.actionGroupId","type":"string","label":"actionGroupId","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_instance_summary.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L31"},"signature":["string | undefined"]},{"id":"def-common.AlertInstanceStatus.actionSubgroup","type":"string","label":"actionSubgroup","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_instance_summary.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L32"},"signature":["string | undefined"]},{"id":"def-common.AlertInstanceStatus.activeStartDate","type":"string","label":"activeStartDate","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_instance_summary.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L33"},"signature":["string | undefined"]}],"source":{"path":"x-pack/plugins/alerts/common/alert_instance_summary.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L28"},"initialIsOpen":false}],"enums":[{"id":"def-common.AlertExecutionStatusErrorReasons","type":"Enum","label":"AlertExecutionStatusErrorReasons","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L23"},"initialIsOpen":false},{"id":"def-common.HealthStatus","type":"Enum","label":"HealthStatus","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L80"},"initialIsOpen":false}],"misc":[{"id":"def-common.BASE_ALERT_API_PATH","type":"string","label":"BASE_ALERT_API_PATH","description":[],"source":{"path":"x-pack/plugins/alerts/common/index.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/index.ts#L27"},"signature":["\"/api/alerts\""],"initialIsOpen":false},{"id":"def-common.ALERTS_FEATURE_ID","type":"string","label":"ALERTS_FEATURE_ID","description":[],"source":{"path":"x-pack/plugins/alerts/common/index.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/index.ts#L28"},"signature":["\"alerts\""],"initialIsOpen":false},{"id":"def-common.AlertTypeState","type":"Type","label":"AlertTypeState","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L11"},"signature":["{ [x: string]: unknown; }"],"initialIsOpen":false},{"id":"def-common.AlertTypeParams","type":"Type","label":"AlertTypeParams","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L12"},"signature":["{ [x: string]: unknown; }"],"initialIsOpen":false},{"id":"def-common.AlertExecutionStatuses","type":"Type","label":"AlertExecutionStatuses","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L21"},"signature":["\"unknown\" | \"error\" | \"pending\" | \"ok\" | \"active\""],"initialIsOpen":false},{"id":"def-common.AlertActionParams","type":"Type","label":"AlertActionParams","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L40"},"signature":["SavedObjectAttributes"],"initialIsOpen":false},{"id":"def-common.AlertActionParam","type":"Type","label":"AlertActionParam","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L41"},"signature":["undefined | null | string | number | false | true | ","SavedObjectAttributes"," | ","SavedObjectAttributeSingle","[]"],"initialIsOpen":false},{"id":"def-common.SanitizedAlert","type":"Type","label":"SanitizedAlert","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L78"},"signature":["{ enabled: boolean; id: string; name: string; params: Params; actions: AlertAction[]; muteAll: boolean; tags: string[]; alertTypeId: string; consumer: string; schedule: IntervalSchedule; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; throttle: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; mutedInstanceIds: string[]; executionStatus: AlertExecutionStatus; }"],"initialIsOpen":false},{"id":"def-common.ActionGroupIdsOf","type":"Type","label":"ActionGroupIdsOf","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_type.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_type.ts#L30"},"signature":["T extends ActionGroup ? groups : T extends Readonly> ? groups : never"],"initialIsOpen":false},{"id":"def-common.AlertInstanceMeta","type":"Type","label":"AlertInstanceMeta","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_instance.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance.ts#L22"},"signature":["{ lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; }"],"initialIsOpen":false},{"id":"def-common.AlertInstanceState","type":"Type","label":"AlertInstanceState","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_instance.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance.ts#L25"},"signature":["{ [x: string]: unknown; }"],"initialIsOpen":false},{"id":"def-common.AlertInstanceContext","type":"Type","label":"AlertInstanceContext","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_instance.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance.ts#L28"},"signature":["{ [x: string]: unknown; }"],"initialIsOpen":false},{"id":"def-common.RawAlertInstance","type":"Type","label":"RawAlertInstance","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_instance.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance.ts#L34"},"signature":["{ state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; } | undefined; }"],"initialIsOpen":false},{"id":"def-common.AlertTaskState","type":"Type","label":"AlertTaskState","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_task_instance.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_task_instance.ts#L18"},"signature":["{ alertTypeState?: { [x: string]: unknown; } | undefined; alertInstances?: { [x: string]: { state?: { [x: string]: unknown; } | undefined; meta?: { lastScheduledActions?: ({ subgroup?: string | undefined; } & { group: string; date: Date; }) | undefined; } | undefined; }; } | undefined; previousStartedAt?: Date | null | undefined; }"],"initialIsOpen":false},{"id":"def-common.AlertTaskParams","type":"Type","label":"AlertTaskParams","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_task_instance.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_task_instance.ts#L28"},"signature":["{ alertId: string; } & { spaceId?: string | undefined; }"],"initialIsOpen":false},{"id":"def-common.AlertNavigation","type":"Type","label":"AlertNavigation","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_navigation.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_navigation.ts#L16"},"signature":[{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.AlertUrlNavigation","text":"AlertUrlNavigation"}," | ",{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.AlertStateNavigation","text":"AlertStateNavigation"}],"initialIsOpen":false},{"id":"def-common.AlertStatusValues","type":"Type","label":"AlertStatusValues","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_instance_summary.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L8"},"signature":["\"OK\" | \"Active\" | \"Error\""],"initialIsOpen":false},{"id":"def-common.AlertInstanceStatusValues","type":"Type","label":"AlertInstanceStatusValues","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_instance_summary.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance_summary.ts#L9"},"signature":["\"OK\" | \"Active\""],"initialIsOpen":false},{"id":"def-common.DefaultActionGroupId","type":"Type","label":"DefaultActionGroupId","description":[],"source":{"path":"x-pack/plugins/alerts/common/builtin_action_groups.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/builtin_action_groups.ts#L11"},"signature":["\"default\""],"initialIsOpen":false},{"id":"def-common.RecoveredActionGroupId","type":"Type","label":"RecoveredActionGroupId","description":[],"source":{"path":"x-pack/plugins/alerts/common/builtin_action_groups.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/builtin_action_groups.ts#L13"},"signature":["\"recovered\""],"initialIsOpen":false},{"id":"def-common.ReservedActionGroups","type":"Type","label":"ReservedActionGroups","description":[],"source":{"path":"x-pack/plugins/alerts/common/builtin_action_groups.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/builtin_action_groups.ts#L21"},"signature":["RecoveryActionGroupId | \"recovered\""],"initialIsOpen":false},{"id":"def-common.WithoutReservedActionGroups","type":"Type","label":"WithoutReservedActionGroups","description":[],"source":{"path":"x-pack/plugins/alerts/common/builtin_action_groups.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/builtin_action_groups.ts#L25"},"signature":["ActionGroupIds extends ReservedActionGroups ? never : ActionGroupIds"],"initialIsOpen":false},{"id":"def-common.AlertNotifyWhenType","type":"Type","label":"AlertNotifyWhenType","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_notify_when_type.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_notify_when_type.ts#L13"},"signature":["\"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\""],"initialIsOpen":false}],"objects":[{"id":"def-common.AlertExecutionStatusValues","type":"Object","label":"AlertExecutionStatusValues","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert.ts#L20"},"signature":["readonly [\"ok\", \"active\", \"error\", \"pending\", \"unknown\"]"],"initialIsOpen":false},{"id":"def-common.rawAlertInstance","type":"Object","label":"rawAlertInstance","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_instance.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_instance.ts#L30"},"signature":["PartialC","<{ state: ","RecordC","<","StringC",", ","UnknownC",">; meta: ","PartialC"],"initialIsOpen":false},{"id":"def-common.alertStateSchema","type":"Object","label":"alertStateSchema","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_task_instance.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_task_instance.ts#L12"},"signature":["PartialC","<{ alertTypeState: ","RecordC","<","StringC",", ","UnknownC",">; alertInstances: ","RecordC"],"initialIsOpen":false},{"id":"def-common.alertParamsSchema","type":"Object","label":"alertParamsSchema","description":[],"source":{"path":"x-pack/plugins/alerts/common/alert_task_instance.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/alert_task_instance.ts#L20"},"signature":["IntersectionC","<[","TypeC","<{ alertId: ","StringC","; }>, ","PartialC","<{ spaceId: ","StringC"],"initialIsOpen":false},{"id":"def-common.RecoveredActionGroup","type":"Object","label":"RecoveredActionGroup","description":[],"source":{"path":"x-pack/plugins/alerts/common/builtin_action_groups.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/builtin_action_groups.ts#L14"},"signature":["Readonly<",{"pluginId":"alerts","scope":"common","docId":"kibAlertsPluginApi","section":"def-common.ActionGroup","text":"ActionGroup"},"<\"recovered\">>"],"initialIsOpen":false},{"id":"def-common.DisabledActionTypeIdsForActionGroup","type":"Object","label":"DisabledActionTypeIdsForActionGroup","description":[],"source":{"path":"x-pack/plugins/alerts/common/disabled_action_groups.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/alerts/common/disabled_action_groups.ts#L14"},"signature":["Map"],"initialIsOpen":false}]}} \ No newline at end of file diff --git a/api_docs/alerts.mdx b/api_docs/alerts.mdx new file mode 100644 index 0000000000000..a76cecca3e75c --- /dev/null +++ b/api_docs/alerts.mdx @@ -0,0 +1,38 @@ +--- +id: kibAlertsPluginApi +slug: /kibana-dev-docs/alertsPluginApi +title: alerts +image: https://source.unsplash.com/400x175/?github +summary: API docs for the alerts plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerts'] +--- + +import alertsObj from './alerts.json'; + +## Client + +### Setup + +### Start + +## Server + +### Functions + +### Interfaces + +### Consts, variables and types + +## Common + +### Objects + +### Functions + +### Interfaces + +### Enums + +### Consts, variables and types + diff --git a/api_docs/apm.json b/api_docs/apm.json new file mode 100644 index 0000000000000..b197380b5444b --- /dev/null +++ b/api_docs/apm.json @@ -0,0 +1 @@ +{"id":"apm","client":{"classes":[],"functions":[],"interfaces":[{"id":"def-public.ConfigSchema","type":"Interface","label":"ConfigSchema","description":[],"children":[{"id":"def-public.ConfigSchema.serviceMapEnabled","type":"boolean","label":"serviceMapEnabled","description":[],"source":{"path":"x-pack/plugins/apm/public/index.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/public/index.ts#L15"}},{"id":"def-public.ConfigSchema.profilingEnabled","type":"boolean","label":"profilingEnabled","description":[],"source":{"path":"x-pack/plugins/apm/public/index.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/public/index.ts#L16"}},{"id":"def-public.ConfigSchema.ui","type":"Object","label":"ui","description":[],"source":{"path":"x-pack/plugins/apm/public/index.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/public/index.ts#L17"},"signature":["{ enabled: boolean; }"]}],"source":{"path":"x-pack/plugins/apm/public/index.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/public/index.ts#L14"},"initialIsOpen":false}],"enums":[],"misc":[],"objects":[],"start":{"id":"def-public.ApmPluginStart","type":"Type","label":"ApmPluginStart","description":[],"source":{"path":"x-pack/plugins/apm/public/plugin.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/public/plugin.ts#L45"},"signature":["void"],"lifecycle":"start","initialIsOpen":true}},"server":{"classes":[{"id":"def-server.APMPlugin","type":"Class","label":"APMPlugin","description":[],"signature":[{"pluginId":"apm","scope":"server","docId":"kibApmPluginApi","section":"def-server.APMPlugin","text":"APMPlugin"}," implements ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.Plugin","text":"Plugin"},"<",{"pluginId":"apm","scope":"server","docId":"kibApmPluginApi","section":"def-server.APMPluginSetup","text":"APMPluginSetup"},", void, object, object>"],"children":[{"id":"def-server.APMPlugin.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"initContext","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.PluginInitializerContext","text":"PluginInitializerContext"},""],"description":[],"source":{"path":"x-pack/plugins/apm/server/plugin.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L61"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/apm/server/plugin.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L61"}},{"id":"def-server.APMPlugin.setup","type":"Function","label":"setup","signature":["(core: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreSetup","text":"CoreSetup"},", plugins: { apmOss: ",{"pluginId":"apmOss","scope":"server","docId":"kibApmOssPluginApi","section":"def-server.APMOSSPluginSetup","text":"APMOSSPluginSetup"},"; home: ",{"pluginId":"home","scope":"server","docId":"kibHomePluginApi","section":"def-server.HomeServerPluginSetup","text":"HomeServerPluginSetup"},"; licensing: ",{"pluginId":"licensing","scope":"server","docId":"kibLicensingPluginApi","section":"def-server.LicensingPluginSetup","text":"LicensingPluginSetup"},"; cloud?: ",{"pluginId":"cloud","scope":"server","docId":"kibCloudPluginApi","section":"def-server.CloudSetup","text":"CloudSetup"}],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreSetup","text":"CoreSetup"},""],"description":[],"source":{"path":"x-pack/plugins/apm/server/plugin.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L66"}},{"id":"def-server.APMPlugin.setup.plugins","type":"Object","label":"plugins","description":[],"children":[{"id":"def-server.APMPlugin.setup.plugins.apmOss","type":"Object","label":"apmOss","description":[],"source":{"path":"x-pack/plugins/apm/server/plugin.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L68"},"signature":[{"pluginId":"apmOss","scope":"server","docId":"kibApmOssPluginApi","section":"def-server.APMOSSPluginSetup","text":"APMOSSPluginSetup"}]},{"id":"def-server.APMPlugin.setup.plugins.home","type":"Object","label":"home","description":[],"source":{"path":"x-pack/plugins/apm/server/plugin.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L69"},"signature":[{"pluginId":"home","scope":"server","docId":"kibHomePluginApi","section":"def-server.HomeServerPluginSetup","text":"HomeServerPluginSetup"}]},{"id":"def-server.APMPlugin.setup.plugins.licensing","type":"Object","label":"licensing","description":[],"source":{"path":"x-pack/plugins/apm/server/plugin.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L70"},"signature":[{"pluginId":"licensing","scope":"server","docId":"kibLicensingPluginApi","section":"def-server.LicensingPluginSetup","text":"LicensingPluginSetup"}]},{"id":"def-server.APMPlugin.setup.plugins.cloud","type":"Object","label":"cloud","description":[],"source":{"path":"x-pack/plugins/apm/server/plugin.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L71"},"signature":[{"pluginId":"cloud","scope":"server","docId":"kibCloudPluginApi","section":"def-server.CloudSetup","text":"CloudSetup"}," | undefined"]},{"id":"def-server.APMPlugin.setup.plugins.usageCollection","type":"Object","label":"usageCollection","description":[],"source":{"path":"x-pack/plugins/apm/server/plugin.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L72"},"signature":["Pick<",{"pluginId":"usageCollection","scope":"server","docId":"kibUsageCollectionPluginApi","section":"def-server.CollectorSet","text":"CollectorSet"},", \"makeStatsCollector\" | \"makeUsageCollector\" | \"registerCollector\" | \"getCollectorByType\" | \"areAllCollectorsReady\" | \"bulkFetch\" | \"bulkFetchUsage\" | \"toObject\" | \"toApiFieldNames\"> | undefined"]},{"id":"def-server.APMPlugin.setup.plugins.taskManager","type":"CompoundType","label":"taskManager","description":[],"source":{"path":"x-pack/plugins/apm/server/plugin.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L73"},"signature":[{"pluginId":"taskManager","scope":"server","docId":"kibTaskManagerPluginApi","section":"def-server.TaskManagerSetupContract","text":"TaskManagerSetupContract"}," | undefined"]},{"id":"def-server.APMPlugin.setup.plugins.alerts","type":"Object","label":"alerts","description":[],"source":{"path":"x-pack/plugins/apm/server/plugin.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L74"},"signature":[{"pluginId":"alerts","scope":"server","docId":"kibAlertsPluginApi","section":"def-server.PluginSetupContract","text":"PluginSetupContract"}," | undefined"]},{"id":"def-server.APMPlugin.setup.plugins.actions","type":"Object","label":"actions","description":[],"source":{"path":"x-pack/plugins/apm/server/plugin.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L75"},"signature":[{"pluginId":"actions","scope":"server","docId":"kibActionsPluginApi","section":"def-server.PluginSetupContract","text":"PluginSetupContract"}," | undefined"]},{"id":"def-server.APMPlugin.setup.plugins.observability","type":"Object","label":"observability","description":[],"source":{"path":"x-pack/plugins/apm/server/plugin.ts","lineNumber":76,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L76"},"signature":[{"pluginId":"observability","scope":"server","docId":"kibObservabilityPluginApi","section":"def-server.ObservabilityPluginSetup","text":"ObservabilityPluginSetup"}," | undefined"]},{"id":"def-server.APMPlugin.setup.plugins.features","type":"Object","label":"features","description":[],"source":{"path":"x-pack/plugins/apm/server/plugin.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L77"},"signature":[{"pluginId":"features","scope":"server","docId":"kibFeaturesPluginApi","section":"def-server.PluginSetupContract","text":"PluginSetupContract"}]},{"id":"def-server.APMPlugin.setup.plugins.security","type":"Object","label":"security","description":[],"source":{"path":"x-pack/plugins/apm/server/plugin.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L78"},"signature":[{"pluginId":"security","scope":"server","docId":"kibSecurityPluginApi","section":"def-server.SecurityPluginSetup","text":"SecurityPluginSetup"}," | undefined"]},{"id":"def-server.APMPlugin.setup.plugins.ml","type":"CompoundType","label":"ml","description":[],"source":{"path":"x-pack/plugins/apm/server/plugin.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L79"},"signature":[{"pluginId":"ml","scope":"server","docId":"kibMlPluginApi","section":"def-server.SharedServices","text":"SharedServices"}," | undefined"]}],"source":{"path":"x-pack/plugins/apm/server/plugin.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L67"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/apm/server/plugin.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L65"}},{"id":"def-server.APMPlugin.start","type":"Function","label":"start","signature":["(core: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreStart","text":"CoreStart"},") => void"],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreStart","text":"CoreStart"}],"description":[],"source":{"path":"x-pack/plugins/apm/server/plugin.ts","lineNumber":196,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L196"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/apm/server/plugin.ts","lineNumber":196,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L196"}},{"id":"def-server.APMPlugin.stop","type":"Function","label":"stop","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/apm/server/plugin.ts","lineNumber":215,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L215"}}],"source":{"path":"x-pack/plugins/apm/server/plugin.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L58"},"initialIsOpen":false}],"functions":[{"id":"def-server.mergeConfigs","type":"Function","label":"mergeConfigs","signature":["(apmOssConfig: Readonly<{} & { enabled: boolean; transactionIndices: string; spanIndices: string; errorIndices: string; metricsIndices: string; sourcemapIndices: string; onboardingIndices: string; indexPattern: string; fleetMode: boolean; }>, apmConfig: Readonly<{} & { enabled: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapTraceIdBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; autocreateApmIndexPattern: boolean; ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; searchAggregatedTransactions: ","SearchAggregatedTransactionSetting","; telemetryCollectionEnabled: boolean; metricsInterval: number; maxServiceEnvironments: number; maxServiceSelection: number; profilingEnabled: boolean; }>) => { 'apm_oss.transactionIndices': string; 'apm_oss.spanIndices': string; 'apm_oss.errorIndices': string; 'apm_oss.metricsIndices': string; 'apm_oss.sourcemapIndices': string; 'apm_oss.onboardingIndices': string; 'apm_oss.indexPattern': string; 'xpack.apm.serviceMapEnabled': boolean; 'xpack.apm.serviceMapFingerprintBucketSize': number; 'xpack.apm.serviceMapTraceIdBucketSize': number; 'xpack.apm.serviceMapFingerprintGlobalBucketSize': number; 'xpack.apm.serviceMapTraceIdGlobalBucketSize': number; 'xpack.apm.serviceMapMaxTracesPerRequest': number; 'xpack.apm.ui.enabled': boolean; 'xpack.apm.maxServiceEnvironments': number; 'xpack.apm.maxServiceSelection': number; 'xpack.apm.ui.maxTraceItems': number; 'xpack.apm.ui.transactionGroupBucketSize': number; 'xpack.apm.autocreateApmIndexPattern': boolean; 'xpack.apm.telemetryCollectionEnabled': boolean; 'xpack.apm.searchAggregatedTransactions': ","SearchAggregatedTransactionSetting","; 'xpack.apm.metricsInterval': number; }"],"description":[],"children":[{"type":"Object","label":"apmOssConfig","isRequired":true,"signature":["Readonly<{} & { enabled: boolean; transactionIndices: string; spanIndices: string; errorIndices: string; metricsIndices: string; sourcemapIndices: string; onboardingIndices: string; indexPattern: string; fleetMode: boolean; }>"],"description":[],"source":{"path":"x-pack/plugins/apm/server/index.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/index.ts#L60"}},{"type":"Object","label":"apmConfig","isRequired":true,"signature":["Readonly<{} & { enabled: boolean; serviceMapEnabled: boolean; serviceMapFingerprintBucketSize: number; serviceMapTraceIdBucketSize: number; serviceMapFingerprintGlobalBucketSize: number; serviceMapTraceIdGlobalBucketSize: number; serviceMapMaxTracesPerRequest: number; autocreateApmIndexPattern: boolean; ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; searchAggregatedTransactions: ",{"pluginId":"apm","scope":"common","docId":"kibApmPluginApi","section":"def-common.SearchAggregatedTransactionSetting","text":"SearchAggregatedTransactionSetting"},"; telemetryCollectionEnabled: boolean; metricsInterval: number; maxServiceEnvironments: number; maxServiceSelection: number; profilingEnabled: boolean; }>"],"description":[],"source":{"path":"x-pack/plugins/apm/server/index.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/index.ts#L61"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/apm/server/index.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/index.ts#L59"},"initialIsOpen":false}],"interfaces":[],"enums":[{"id":"def-server.ProcessorEvent","type":"Enum","label":"ProcessorEvent","description":[],"source":{"path":"x-pack/plugins/apm/common/processor_event.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/common/processor_event.ts#L8"},"initialIsOpen":false}],"misc":[{"id":"def-server.APMXPackConfig","type":"Type","label":"APMXPackConfig","description":[],"source":{"path":"x-pack/plugins/apm/server/index.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/index.ts#L55"},"signature":["{ readonly enabled: boolean; readonly serviceMapEnabled: boolean; readonly serviceMapFingerprintBucketSize: number; readonly serviceMapTraceIdBucketSize: number; readonly serviceMapFingerprintGlobalBucketSize: number; readonly serviceMapTraceIdGlobalBucketSize: number; readonly serviceMapMaxTracesPerRequest: number; readonly autocreateApmIndexPattern: boolean; readonly ui: Readonly<{} & { enabled: boolean; transactionGroupBucketSize: number; maxTraceItems: number; }>; readonly searchAggregatedTransactions: SearchAggregatedTransactionSetting; readonly telemetryCollectionEnabled: boolean; readonly metricsInterval: number; readonly maxServiceEnvironments: number; readonly maxServiceSelection: number; readonly profilingEnabled: boolean; }"],"initialIsOpen":false},{"id":"def-server.APMConfig","type":"Type","label":"APMConfig","description":[],"source":{"path":"x-pack/plugins/apm/server/index.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/index.ts#L56"},"signature":["{ 'apm_oss.transactionIndices': string; 'apm_oss.spanIndices': string; 'apm_oss.errorIndices': string; 'apm_oss.metricsIndices': string; 'apm_oss.sourcemapIndices': string; 'apm_oss.onboardingIndices': string; 'apm_oss.indexPattern': string; 'xpack.apm.serviceMapEnabled': boolean; 'xpack.apm.serviceMapFingerprintBucketSize': number; 'xpack.apm.serviceMapTraceIdBucketSize': number; 'xpack.apm.serviceMapFingerprintGlobalBucketSize': number; 'xpack.apm.serviceMapTraceIdGlobalBucketSize': number; 'xpack.apm.serviceMapMaxTracesPerRequest': number; 'xpack.apm.ui.enabled': boolean; 'xpack.apm.maxServiceEnvironments': number; 'xpack.apm.maxServiceSelection': number; 'xpack.apm.ui.maxTraceItems': number; 'xpack.apm.ui.transactionGroupBucketSize': number; 'xpack.apm.autocreateApmIndexPattern': boolean; 'xpack.apm.telemetryCollectionEnabled': boolean; 'xpack.apm.searchAggregatedTransactions': SearchAggregatedTransactionSetting; 'xpack.apm.metricsInterval': number; }"],"initialIsOpen":false}],"objects":[],"setup":{"id":"def-server.APMPluginSetup","type":"Interface","label":"APMPluginSetup","description":[],"children":[{"id":"def-server.APMPluginSetup.config$","type":"Object","label":"config$","description":[],"source":{"path":"x-pack/plugins/apm/server/plugin.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L49"},"signature":["Observable","<{ 'apm_oss.transactionIndices': string; 'apm_oss.spanIndices': string; 'apm_oss.errorIndices': string; 'apm_oss.metricsIndices': string; 'apm_oss.sourcemapIndices': string; 'apm_oss.onboardingIndices': string; 'apm_oss.indexPattern': string; 'xpack.apm.serviceMapEnabled': boolean; 'xpack.apm.serviceMapFingerprintBucketSize': number; 'xpack.apm.serviceMapTraceIdBucketSize': number; 'xpack.apm.serviceMapFingerprintGlobalBucketSize': number; 'xpack.apm.serviceMapTraceIdGlobalBucketSize': number; 'xpack.apm.serviceMapMaxTracesPerRequest': number; 'xpack.apm.ui.enabled': boolean; 'xpack.apm.maxServiceEnvironments': number; 'xpack.apm.maxServiceSelection': number; 'xpack.apm.ui.maxTraceItems': number; 'xpack.apm.ui.transactionGroupBucketSize': number; 'xpack.apm.autocreateApmIndexPattern': boolean; 'xpack.apm.telemetryCollectionEnabled': boolean; 'xpack.apm.searchAggregatedTransactions': ",{"pluginId":"apm","scope":"common","docId":"kibApmPluginApi","section":"def-common.SearchAggregatedTransactionSetting","text":"SearchAggregatedTransactionSetting"},"; 'xpack.apm.metricsInterval': number; }>"]},{"id":"def-server.APMPluginSetup.getApmIndices","type":"Function","label":"getApmIndices","description":[],"source":{"path":"x-pack/plugins/apm/server/plugin.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L50"},"signature":["() => Promise<",{"pluginId":"apm","scope":"server","docId":"kibApmPluginApi","section":"def-server.ApmIndicesConfig","text":"ApmIndicesConfig"},">"]},{"id":"def-server.APMPluginSetup.createApmEventClient","type":"Function","label":"createApmEventClient","description":[],"source":{"path":"x-pack/plugins/apm/server/plugin.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/apm/server/plugin.ts#L51"},"signature":["(params: { debug?: boolean | undefined; request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},"; context: ",{"pluginId":"apm","scope":"server","docId":"kibApmPluginApi","section":"def-server.ApmPluginRequestHandlerContext","text":"ApmPluginRequestHandlerContext"},"; }) => Promise<{ search(params: TParams, { includeLegacyData }?: { includeLegacyData?: boolean | undefined; }): Promise<","ESSearchResponse"," +### Interfaces + +## Server + +### Setup + +### Functions + +### Classes + +### Enums + +### Consts, variables and types + diff --git a/api_docs/apm_oss.json b/api_docs/apm_oss.json new file mode 100644 index 0000000000000..8c23058220466 --- /dev/null +++ b/api_docs/apm_oss.json @@ -0,0 +1 @@ +{"id":"apmOss","client":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[{"id":"def-public.APM_STATIC_INDEX_PATTERN_ID","type":"string","label":"APM_STATIC_INDEX_PATTERN_ID","description":[],"source":{"path":"src/plugins/apm_oss/common/index_pattern_constants.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/common/index_pattern_constants.ts#L9"},"signature":["\"apm_static_index_pattern_id\""],"initialIsOpen":false}],"objects":[],"setup":{"id":"def-public.ApmOssPluginSetup","type":"Interface","label":"ApmOssPluginSetup","description":[],"children":[],"source":{"path":"src/plugins/apm_oss/public/types.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/public/types.ts#L10"},"lifecycle":"setup","initialIsOpen":true},"start":{"id":"def-public.ApmOssPluginStart","type":"Interface","label":"ApmOssPluginStart","description":[],"children":[],"source":{"path":"src/plugins/apm_oss/public/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/public/types.ts#L13"},"lifecycle":"start","initialIsOpen":true}},"server":{"classes":[],"functions":[{"id":"def-server.createNodeAgentInstructions","type":"Function","children":[{"type":"string","label":"apmServerUrl","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L11"}},{"type":"string","label":"secretToken","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L11"}}],"signature":["(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]"],"description":[],"label":"createNodeAgentInstructions","source":{"path":"src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L11"},"returnComment":[],"initialIsOpen":false},{"id":"def-server.createDjangoAgentInstructions","type":"Function","children":[{"type":"string","label":"apmServerUrl","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L88"}},{"type":"string","label":"secretToken","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L88"}}],"signature":["(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]"],"description":[],"label":"createDjangoAgentInstructions","source":{"path":"src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L88"},"returnComment":[],"initialIsOpen":false},{"id":"def-server.createFlaskAgentInstructions","type":"Function","children":[{"type":"string","label":"apmServerUrl","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts","lineNumber":173,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L173"}},{"type":"string","label":"secretToken","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts","lineNumber":173,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L173"}}],"signature":["(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]"],"description":[],"label":"createFlaskAgentInstructions","source":{"path":"src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts","lineNumber":173,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L173"},"returnComment":[],"initialIsOpen":false},{"id":"def-server.createRailsAgentInstructions","type":"Function","children":[{"type":"string","label":"apmServerUrl","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts","lineNumber":255,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L255"}},{"type":"string","label":"secretToken","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts","lineNumber":255,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L255"}}],"signature":["(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]"],"description":[],"label":"createRailsAgentInstructions","source":{"path":"src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts","lineNumber":255,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L255"},"returnComment":[],"initialIsOpen":false},{"id":"def-server.createRackAgentInstructions","type":"Function","children":[{"type":"string","label":"apmServerUrl","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts","lineNumber":298,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L298"}},{"type":"string","label":"secretToken","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts","lineNumber":298,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L298"}}],"signature":["(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]"],"description":[],"label":"createRackAgentInstructions","source":{"path":"src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts","lineNumber":298,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L298"},"returnComment":[],"initialIsOpen":false},{"id":"def-server.createJsAgentInstructions","type":"Function","children":[{"type":"string","label":"apmServerUrl","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts","lineNumber":393,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L393"}}],"signature":["(apmServerUrl?: string) => ({ title: string; textPre: string; commands?: undefined; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; } | { title: string; textPre: string; commands: string[]; textPost?: undefined; })[]"],"description":[],"label":"createJsAgentInstructions","source":{"path":"src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts","lineNumber":393,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L393"},"returnComment":[],"initialIsOpen":false},{"id":"def-server.createGoAgentInstructions","type":"Function","children":[{"type":"string","label":"apmServerUrl","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts","lineNumber":492,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L492"}},{"type":"string","label":"secretToken","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts","lineNumber":492,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L492"}}],"signature":["(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands: string[]; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]"],"description":[],"label":"createGoAgentInstructions","source":{"path":"src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts","lineNumber":492,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L492"},"returnComment":[],"initialIsOpen":false},{"id":"def-server.createJavaAgentInstructions","type":"Function","children":[{"type":"string","label":"apmServerUrl","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts","lineNumber":585,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L585"}},{"type":"string","label":"secretToken","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts","lineNumber":585,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L585"}}],"signature":["(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands?: undefined; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]"],"description":[],"label":"createJavaAgentInstructions","source":{"path":"src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts","lineNumber":585,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L585"},"returnComment":[],"initialIsOpen":false},{"id":"def-server.createDotNetAgentInstructions","type":"Function","children":[{"type":"string","label":"apmServerUrl","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts","lineNumber":631,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L631"}},{"type":"string","label":"secretToken","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts","lineNumber":631,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L631"}}],"signature":["(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands?: undefined; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; } | { title: string; commands: string[]; textPost: string; textPre?: undefined; })[]"],"description":[],"label":"createDotNetAgentInstructions","source":{"path":"src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts","lineNumber":631,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L631"},"returnComment":[],"initialIsOpen":false},{"id":"def-server.createPhpAgentInstructions","type":"Function","children":[{"type":"string","label":"apmServerUrl","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts","lineNumber":705,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L705"}},{"type":"string","label":"secretToken","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts","lineNumber":705,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L705"}}],"signature":["(apmServerUrl?: string, secretToken?: string) => ({ title: string; textPre: string; commands?: undefined; textPost?: undefined; } | { title: string; textPre: string; commands: string[]; textPost: string; })[]"],"description":[],"label":"createPhpAgentInstructions","source":{"path":"src/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts","lineNumber":705,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/tutorial/instructions/apm_agent_instructions.ts#L705"},"returnComment":[],"initialIsOpen":false}],"interfaces":[],"enums":[],"misc":[{"id":"def-server.APMOSSConfig","type":"Type","label":"APMOSSConfig","description":[],"source":{"path":"src/plugins/apm_oss/server/index.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/index.ts#L32"},"signature":["{ readonly enabled: boolean; readonly transactionIndices: string; readonly spanIndices: string; readonly errorIndices: string; readonly metricsIndices: string; readonly sourcemapIndices: string; readonly onboardingIndices: string; readonly indexPattern: string; readonly fleetMode: boolean; }"],"initialIsOpen":false},{"id":"def-server.APM_STATIC_INDEX_PATTERN_ID","type":"string","label":"APM_STATIC_INDEX_PATTERN_ID","description":[],"source":{"path":"src/plugins/apm_oss/common/index_pattern_constants.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/common/index_pattern_constants.ts#L9"},"signature":["\"apm_static_index_pattern_id\""],"initialIsOpen":false}],"objects":[],"setup":{"id":"def-server.APMOSSPluginSetup","type":"Interface","label":"APMOSSPluginSetup","description":[],"children":[{"id":"def-server.APMOSSPluginSetup.config","type":"Object","label":"config","description":[],"source":{"path":"src/plugins/apm_oss/server/plugin.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/plugin.ts#L48"},"signature":["Readonly<{} & { enabled: boolean; transactionIndices: string; spanIndices: string; errorIndices: string; metricsIndices: string; sourcemapIndices: string; onboardingIndices: string; indexPattern: string; fleetMode: boolean; }>"]},{"id":"def-server.APMOSSPluginSetup.config$","type":"Object","label":"config$","description":[],"source":{"path":"src/plugins/apm_oss/server/plugin.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/plugin.ts#L49"},"signature":["Observable",">"]},{"id":"def-server.APMOSSPluginSetup.getRegisteredTutorialProvider","type":"Function","label":"getRegisteredTutorialProvider","signature":["() => ",{"pluginId":"home","scope":"server","docId":"kibHomePluginApi","section":"def-server.TutorialProvider","text":"TutorialProvider"}],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/apm_oss/server/plugin.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/plugin.ts#L50"}}],"source":{"path":"src/plugins/apm_oss/server/plugin.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/apm_oss/server/plugin.ts#L47"},"lifecycle":"setup","initialIsOpen":true}},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]}} \ No newline at end of file diff --git a/api_docs/apm_oss.mdx b/api_docs/apm_oss.mdx new file mode 100644 index 0000000000000..31176d17871c0 --- /dev/null +++ b/api_docs/apm_oss.mdx @@ -0,0 +1,28 @@ +--- +id: kibApmOssPluginApi +slug: /kibana-dev-docs/apmOssPluginApi +title: apmOss +image: https://source.unsplash.com/400x175/?github +summary: API docs for the apmOss plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'apmOss'] +--- + +import apmOssObj from './apm_oss.json'; + +## Client + +### Setup + +### Start + +### Consts, variables and types + +## Server + +### Setup + +### Functions + +### Consts, variables and types + diff --git a/api_docs/banners.json b/api_docs/banners.json new file mode 100644 index 0000000000000..28cd94bb72aec --- /dev/null +++ b/api_docs/banners.json @@ -0,0 +1 @@ +{"id":"banners","client":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"server":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"common":{"classes":[],"functions":[],"interfaces":[{"id":"def-common.BannerInfoResponse","type":"Interface","label":"BannerInfoResponse","description":[],"children":[{"id":"def-common.BannerInfoResponse.allowed","type":"boolean","label":"allowed","description":[],"source":{"path":"x-pack/plugins/banners/common/types.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L9"}},{"id":"def-common.BannerInfoResponse.banner","type":"Object","label":"banner","description":[],"source":{"path":"x-pack/plugins/banners/common/types.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L10"},"signature":[{"pluginId":"banners","scope":"common","docId":"kibBannersPluginApi","section":"def-common.BannerConfiguration","text":"BannerConfiguration"}]}],"source":{"path":"x-pack/plugins/banners/common/types.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L8"},"initialIsOpen":false},{"id":"def-common.BannerConfiguration","type":"Interface","label":"BannerConfiguration","description":[],"children":[{"id":"def-common.BannerConfiguration.placement","type":"CompoundType","label":"placement","description":[],"source":{"path":"x-pack/plugins/banners/common/types.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L16"},"signature":[{"pluginId":"banners","scope":"common","docId":"kibBannersPluginApi","section":"def-common.BannerPlacement","text":"BannerPlacement"}]},{"id":"def-common.BannerConfiguration.textContent","type":"string","label":"textContent","description":[],"source":{"path":"x-pack/plugins/banners/common/types.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L17"}},{"id":"def-common.BannerConfiguration.textColor","type":"string","label":"textColor","description":[],"source":{"path":"x-pack/plugins/banners/common/types.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L18"}},{"id":"def-common.BannerConfiguration.backgroundColor","type":"string","label":"backgroundColor","description":[],"source":{"path":"x-pack/plugins/banners/common/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L19"}}],"source":{"path":"x-pack/plugins/banners/common/types.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L15"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-common.BannerPlacement","type":"Type","label":"BannerPlacement","description":[],"source":{"path":"x-pack/plugins/banners/common/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/banners/common/types.ts#L13"},"signature":["\"disabled\" | \"header\""],"initialIsOpen":false}],"objects":[]}} \ No newline at end of file diff --git a/api_docs/banners.mdx b/api_docs/banners.mdx new file mode 100644 index 0000000000000..07af686f06b96 --- /dev/null +++ b/api_docs/banners.mdx @@ -0,0 +1,18 @@ +--- +id: kibBannersPluginApi +slug: /kibana-dev-docs/bannersPluginApi +title: banners +image: https://source.unsplash.com/400x175/?github +summary: API docs for the banners plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'banners'] +--- + +import bannersObj from './banners.json'; + +## Common + +### Interfaces + +### Consts, variables and types + diff --git a/api_docs/beats_management.json b/api_docs/beats_management.json new file mode 100644 index 0000000000000..dfb69c2a55f7e --- /dev/null +++ b/api_docs/beats_management.json @@ -0,0 +1 @@ +{"id":"beatsManagement","client":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"server":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[{"id":"def-common.BeatsManagementConfigType","type":"Type","label":"BeatsManagementConfigType","description":[],"source":{"path":"x-pack/plugins/beats_management/common/index.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/beats_management/common/index.ts#L23"},"signature":["{ readonly enabled: boolean; readonly defaultUserRoles: string[]; readonly encryptionKey: string; readonly enrollmentTokensTtlInSeconds: number; }"],"initialIsOpen":false}],"objects":[{"id":"def-common.beatsManagementConfigSchema","type":"Object","label":"beatsManagementConfigSchema","description":[],"source":{"path":"x-pack/plugins/beats_management/common/index.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/beats_management/common/index.ts#L12"},"signature":["ObjectType","<{ enabled: ","Type","; defaultUserRoles: ","Type","; encryptionKey: ","Type","; enrollmentTokensTtlInSeconds: ","Type"],"initialIsOpen":false}]}} \ No newline at end of file diff --git a/api_docs/beats_management.mdx b/api_docs/beats_management.mdx new file mode 100644 index 0000000000000..7cafd984994da --- /dev/null +++ b/api_docs/beats_management.mdx @@ -0,0 +1,18 @@ +--- +id: kibBeatsManagementPluginApi +slug: /kibana-dev-docs/beatsManagementPluginApi +title: beatsManagement +image: https://source.unsplash.com/400x175/?github +summary: API docs for the beatsManagement plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'beatsManagement'] +--- + +import beatsManagementObj from './beats_management.json'; + +## Common + +### Objects + +### Consts, variables and types + diff --git a/api_docs/bfetch.json b/api_docs/bfetch.json new file mode 100644 index 0000000000000..c3a3d8312d29a --- /dev/null +++ b/api_docs/bfetch.json @@ -0,0 +1 @@ +{"id":"bfetch","client":{"classes":[],"functions":[{"id":"def-public.split","type":"Function","children":[{"type":"string","label":"delimiter","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/bfetch/public/streaming/split.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/public/streaming/split.ts#L25"}}],"signature":["(delimiter?: string) => (in$: ","Observable",") => ","Observable",""],"description":["\nReceives observable that emits strings, and returns a new observable\nthat also returns strings separated by delimiter.\n\nInput stream:\n\n asdf.f -> df..aaa. -> dfsdf\n\nOutput stream, assuming \".\" is used as delimiter:\n\n asdf -> fdf -> aaa -> dfsdf\n"],"label":"split","source":{"path":"src/plugins/bfetch/public/streaming/split.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/public/streaming/split.ts#L25"},"returnComment":[],"initialIsOpen":false}],"interfaces":[],"enums":[],"misc":[{"id":"def-public.BatchedFunc","type":"Type","label":"BatchedFunc","description":[],"source":{"path":"src/plugins/bfetch/public/batching/types.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/public/batching/types.ts#L17"},"signature":["(payload: Payload, signal: AbortSignal | undefined) => Promise"],"initialIsOpen":false}],"objects":[],"start":{"id":"def-public.BfetchPublicContract","type":"Interface","label":"BfetchPublicContract","description":[],"children":[{"id":"def-public.BfetchPublicContract.fetchStreaming","type":"Function","label":"fetchStreaming","description":[],"source":{"path":"src/plugins/bfetch/public/plugin.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/public/plugin.ts#L25"},"signature":["(params: ",{"pluginId":"bfetch","scope":"public","docId":"kibBfetchPluginApi","section":"def-public.FetchStreamingParams","text":"FetchStreamingParams"},") => { xhr: XMLHttpRequest; stream: ","Observable","; }"]},{"id":"def-public.BfetchPublicContract.batchedFunction","type":"Function","label":"batchedFunction","description":[],"source":{"path":"src/plugins/bfetch/public/plugin.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/public/plugin.ts#L26"},"signature":["(params: ",{"pluginId":"bfetch","scope":"public","docId":"kibBfetchPluginApi","section":"def-public.StreamingBatchedFunctionParams","text":"StreamingBatchedFunctionParams"},") => ",{"pluginId":"bfetch","scope":"public","docId":"kibBfetchPluginApi","section":"def-public.BatchedFunc","text":"BatchedFunc"},""]}],"source":{"path":"src/plugins/bfetch/public/plugin.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/public/plugin.ts#L24"},"lifecycle":"start","initialIsOpen":true}},"server":{"classes":[],"functions":[],"interfaces":[{"id":"def-server.BatchProcessingRouteParams","type":"Interface","label":"BatchProcessingRouteParams","signature":[{"pluginId":"bfetch","scope":"server","docId":"kibBfetchPluginApi","section":"def-server.BatchProcessingRouteParams","text":"BatchProcessingRouteParams"},""],"description":[],"children":[{"id":"def-server.BatchProcessingRouteParams.onBatchItem","type":"Function","label":"onBatchItem","description":[],"source":{"path":"src/plugins/bfetch/server/plugin.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/server/plugin.ts#L40"},"signature":["(data: BatchItemData) => Promise"]}],"source":{"path":"src/plugins/bfetch/server/plugin.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/server/plugin.ts#L39"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-server.StreamingRequestHandler","type":"Type","label":"StreamingRequestHandler","description":["\nRequest handler modified to allow to return an observable.\n\nSee {@link BfetchServerSetup.createStreamingRequestHandler} for usage example."],"source":{"path":"src/plugins/bfetch/server/types.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/server/types.ts#L18"},"signature":["(context: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.RequestHandlerContext","text":"RequestHandlerContext"},", request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},") => ","Observable"," | Promise<","Observable",">"],"initialIsOpen":false}],"objects":[],"setup":{"id":"def-server.BfetchServerSetup","type":"Interface","label":"BfetchServerSetup","description":[],"children":[{"id":"def-server.BfetchServerSetup.addBatchProcessingRoute","type":"Function","label":"addBatchProcessingRoute","description":[],"source":{"path":"src/plugins/bfetch/server/plugin.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/server/plugin.ts#L45"},"signature":["(path: string, handler: (request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},") => ",{"pluginId":"bfetch","scope":"server","docId":"kibBfetchPluginApi","section":"def-server.BatchProcessingRouteParams","text":"BatchProcessingRouteParams"},") => void"]},{"id":"def-server.BfetchServerSetup.addStreamingResponseRoute","type":"Function","label":"addStreamingResponseRoute","description":[],"source":{"path":"src/plugins/bfetch/server/plugin.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/server/plugin.ts#L49"},"signature":["(path: string, params: (request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},") => ",{"pluginId":"bfetch","scope":"common","docId":"kibBfetchPluginApi","section":"def-common.StreamingResponseHandler","text":"StreamingResponseHandler"},") => void"]},{"id":"def-server.BfetchServerSetup.createStreamingRequestHandler","type":"Function","label":"createStreamingRequestHandler","description":["\nCreate a streaming request handler to be able to use an Observable to return chunked content to the client.\nThis is meant to be used with the `fetchStreaming` API of the `bfetch` client-side plugin.\n"],"source":{"path":"src/plugins/bfetch/server/plugin.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/server/plugin.ts#L81"},"signature":["(streamHandler: ",{"pluginId":"bfetch","scope":"server","docId":"kibBfetchPluginApi","section":"def-server.StreamingRequestHandler","text":"StreamingRequestHandler"},") => ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RequestHandler","text":"RequestHandler"}]}],"source":{"path":"src/plugins/bfetch/server/plugin.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/server/plugin.ts#L44"},"lifecycle":"setup","initialIsOpen":true},"start":{"id":"def-server.BfetchServerStart","type":"Interface","label":"BfetchServerStart","description":[],"children":[],"source":{"path":"src/plugins/bfetch/server/plugin.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/server/plugin.ts#L94"},"lifecycle":"start","initialIsOpen":true}},"common":{"classes":[{"id":"def-common.ItemBuffer","type":"Class","label":"ItemBuffer","description":["\nA simple buffer that collects items. Can be cleared or flushed; and can\nautomatically flush when specified number of items is reached."],"signature":[{"pluginId":"bfetch","scope":"common","docId":"kibBfetchPluginApi","section":"def-common.ItemBuffer","text":"ItemBuffer"},""],"children":[{"id":"def-common.ItemBuffer.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"params","isRequired":true,"signature":[{"pluginId":"bfetch","scope":"common","docId":"kibBfetchPluginApi","section":"def-common.ItemBufferParams","text":"ItemBufferParams"},""],"description":[],"source":{"path":"src/plugins/bfetch/common/buffer/item_buffer.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L32"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/bfetch/common/buffer/item_buffer.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L32"}},{"id":"def-common.ItemBuffer.length","type":"number","label":"length","description":["\nGet current buffer size."],"source":{"path":"src/plugins/bfetch/common/buffer/item_buffer.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L37"}},{"id":"def-common.ItemBuffer.write","type":"Function","label":"write","signature":["(item: Item) => void"],"description":["\nAdd item to the buffer."],"children":[{"type":"Uncategorized","label":"item","isRequired":true,"signature":["Item"],"description":[],"source":{"path":"src/plugins/bfetch/common/buffer/item_buffer.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L44"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/bfetch/common/buffer/item_buffer.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L44"}},{"id":"def-common.ItemBuffer.clear","type":"Function","label":"clear","signature":["() => void"],"description":["\nRemove all items from the buffer."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/bfetch/common/buffer/item_buffer.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L58"}},{"id":"def-common.ItemBuffer.flush","type":"Function","label":"flush","signature":["() => void"],"description":["\nCall `.onflush` method and clear buffer."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/bfetch/common/buffer/item_buffer.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L65"}}],"source":{"path":"src/plugins/bfetch/common/buffer/item_buffer.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L29"},"initialIsOpen":false},{"id":"def-common.TimedItemBuffer","type":"Class","label":"TimedItemBuffer","description":[],"signature":[{"pluginId":"bfetch","scope":"common","docId":"kibBfetchPluginApi","section":"def-common.TimedItemBuffer","text":"TimedItemBuffer"}," extends ",{"pluginId":"bfetch","scope":"common","docId":"kibBfetchPluginApi","section":"def-common.ItemBuffer","text":"ItemBuffer"},""],"children":[{"id":"def-common.TimedItemBuffer.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"params","isRequired":true,"signature":[{"pluginId":"bfetch","scope":"common","docId":"kibBfetchPluginApi","section":"def-common.TimedItemBufferParams","text":"TimedItemBufferParams"},""],"description":[],"source":{"path":"src/plugins/bfetch/common/buffer/timed_item_buffer.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/timed_item_buffer.ts#L22"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/bfetch/common/buffer/timed_item_buffer.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/timed_item_buffer.ts#L22"}},{"id":"def-common.TimedItemBuffer.write","type":"Function","label":"write","signature":["(item: Item) => void"],"description":[],"children":[{"type":"Uncategorized","label":"item","isRequired":true,"signature":["Item"],"description":[],"source":{"path":"src/plugins/bfetch/common/buffer/timed_item_buffer.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/timed_item_buffer.ts#L26"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/bfetch/common/buffer/timed_item_buffer.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/timed_item_buffer.ts#L26"}},{"id":"def-common.TimedItemBuffer.clear","type":"Function","label":"clear","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/bfetch/common/buffer/timed_item_buffer.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/timed_item_buffer.ts#L34"}},{"id":"def-common.TimedItemBuffer.flush","type":"Function","label":"flush","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/bfetch/common/buffer/timed_item_buffer.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/timed_item_buffer.ts#L39"}}],"source":{"path":"src/plugins/bfetch/common/buffer/timed_item_buffer.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/timed_item_buffer.ts#L19"},"initialIsOpen":false}],"functions":[{"id":"def-common.normalizeError","type":"Function","children":[{"type":"Any","label":"err","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/bfetch/common/util/normalize_error.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/util/normalize_error.ts#L11"}}],"signature":["(err: any) => E"],"description":[],"label":"normalizeError","source":{"path":"src/plugins/bfetch/common/util/normalize_error.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/util/normalize_error.ts#L11"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.removeLeadingSlash","type":"Function","children":[{"type":"string","label":"text","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/bfetch/common/util/remove_leading_slash.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/util/remove_leading_slash.ts#L9"}}],"signature":["(text: string) => string"],"description":[],"label":"removeLeadingSlash","source":{"path":"src/plugins/bfetch/common/util/remove_leading_slash.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/util/remove_leading_slash.ts#L9"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.createBatchedFunction","type":"Function","children":[{"type":"Object","label":"params","isRequired":true,"signature":[{"pluginId":"bfetch","scope":"common","docId":"kibBfetchPluginApi","section":"def-common.BatchedFunctionParams","text":"BatchedFunctionParams"},""],"description":[],"source":{"path":"src/plugins/bfetch/common/buffer/create_batched_function.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/create_batched_function.ts#L22"}}],"signature":["(params: ",{"pluginId":"bfetch","scope":"common","docId":"kibBfetchPluginApi","section":"def-common.BatchedFunctionParams","text":"BatchedFunctionParams"},") => [Func, ",{"pluginId":"bfetch","scope":"common","docId":"kibBfetchPluginApi","section":"def-common.TimedItemBuffer","text":"TimedItemBuffer"},"]"],"description":[],"label":"createBatchedFunction","source":{"path":"src/plugins/bfetch/common/buffer/create_batched_function.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/create_batched_function.ts#L21"},"returnComment":[],"initialIsOpen":false}],"interfaces":[{"id":"def-common.StreamingResponseHandler","type":"Interface","label":"StreamingResponseHandler","signature":[{"pluginId":"bfetch","scope":"common","docId":"kibBfetchPluginApi","section":"def-common.StreamingResponseHandler","text":"StreamingResponseHandler"},""],"description":[],"children":[{"id":"def-common.StreamingResponseHandler.getResponseStream","type":"Function","label":"getResponseStream","signature":["(payload: Payload) => ","Observable",""],"description":[],"children":[{"type":"Uncategorized","label":"payload","isRequired":true,"signature":["Payload"],"description":[],"source":{"path":"src/plugins/bfetch/common/streaming/types.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/streaming/types.ts#L12"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/bfetch/common/streaming/types.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/streaming/types.ts#L12"}}],"source":{"path":"src/plugins/bfetch/common/streaming/types.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/streaming/types.ts#L11"},"initialIsOpen":false},{"id":"def-common.ItemBufferParams","type":"Interface","label":"ItemBufferParams","signature":[{"pluginId":"bfetch","scope":"common","docId":"kibBfetchPluginApi","section":"def-common.ItemBufferParams","text":"ItemBufferParams"},""],"description":[],"children":[{"id":"def-common.ItemBufferParams.flushOnMaxItems","type":"number","label":"flushOnMaxItems","description":["\nFlushes buffer automatically if number of items in the buffer reaches\nthis number. Omit it or set to `Infinity` to never flush on max buffer\nsize automatically."],"source":{"path":"src/plugins/bfetch/common/buffer/item_buffer.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L15"},"signature":["number | undefined"]},{"id":"def-common.ItemBufferParams.onFlush","type":"Function","label":"onFlush","description":["\nCallback that is called every time buffer is flushed. It receives a single\nargument which is a list of all buffered items. If `.flush()` is called\nwhen buffer is empty, `.onflush` is called with empty array."],"source":{"path":"src/plugins/bfetch/common/buffer/item_buffer.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L22"},"signature":["(items: Item[]) => void"]}],"source":{"path":"src/plugins/bfetch/common/buffer/item_buffer.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/item_buffer.ts#L9"},"initialIsOpen":false},{"id":"def-common.TimedItemBufferParams","type":"Interface","label":"TimedItemBufferParams","signature":[{"pluginId":"bfetch","scope":"common","docId":"kibBfetchPluginApi","section":"def-common.TimedItemBufferParams","text":"TimedItemBufferParams"}," extends ",{"pluginId":"bfetch","scope":"common","docId":"kibBfetchPluginApi","section":"def-common.ItemBufferParams","text":"ItemBufferParams"},""],"description":[],"children":[{"id":"def-common.TimedItemBufferParams.maxItemAge","type":"number","label":"maxItemAge","description":["\nFlushes buffer when oldest item reaches age specified by this parameter,\nin milliseconds."],"source":{"path":"src/plugins/bfetch/common/buffer/timed_item_buffer.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/timed_item_buffer.ts#L16"},"signature":["number | undefined"]}],"source":{"path":"src/plugins/bfetch/common/buffer/timed_item_buffer.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/timed_item_buffer.ts#L11"},"initialIsOpen":false},{"id":"def-common.BatchedFunctionParams","type":"Interface","label":"BatchedFunctionParams","signature":[{"pluginId":"bfetch","scope":"common","docId":"kibBfetchPluginApi","section":"def-common.BatchedFunctionParams","text":"BatchedFunctionParams"},""],"description":[],"children":[{"id":"def-common.BatchedFunctionParams.onCall","type":"Function","label":"onCall","description":[],"source":{"path":"src/plugins/bfetch/common/buffer/create_batched_function.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/create_batched_function.ts#L15"},"signature":["(...args: Parameters) => [ReturnType, BatchEntry]"]},{"id":"def-common.BatchedFunctionParams.onBatch","type":"Function","label":"onBatch","description":[],"source":{"path":"src/plugins/bfetch/common/buffer/create_batched_function.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/create_batched_function.ts#L16"},"signature":["(items: BatchEntry[]) => void"]},{"id":"def-common.BatchedFunctionParams.flushOnMaxItems","type":"number","label":"flushOnMaxItems","description":[],"source":{"path":"src/plugins/bfetch/common/buffer/create_batched_function.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/create_batched_function.ts#L17"},"signature":["number | undefined"]},{"id":"def-common.BatchedFunctionParams.maxItemAge","type":"number","label":"maxItemAge","description":[],"source":{"path":"src/plugins/bfetch/common/buffer/create_batched_function.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/create_batched_function.ts#L18"},"signature":["number | undefined"]}],"source":{"path":"src/plugins/bfetch/common/buffer/create_batched_function.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/buffer/create_batched_function.ts#L14"},"initialIsOpen":false},{"id":"def-common.ErrorLike","type":"Interface","label":"ErrorLike","description":[],"children":[{"id":"def-common.ErrorLike.message","type":"string","label":"message","description":[],"source":{"path":"src/plugins/bfetch/common/batch.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/batch.ts#L10"}}],"source":{"path":"src/plugins/bfetch/common/batch.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/batch.ts#L9"},"initialIsOpen":false},{"id":"def-common.BatchRequestData","type":"Interface","label":"BatchRequestData","signature":[{"pluginId":"bfetch","scope":"common","docId":"kibBfetchPluginApi","section":"def-common.BatchRequestData","text":"BatchRequestData"},""],"description":[],"children":[{"id":"def-common.BatchRequestData.batch","type":"Array","label":"batch","description":[],"source":{"path":"src/plugins/bfetch/common/batch.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/batch.ts#L14"},"signature":["Item[]"]}],"source":{"path":"src/plugins/bfetch/common/batch.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/batch.ts#L13"},"initialIsOpen":false},{"id":"def-common.BatchResponseItem","type":"Interface","label":"BatchResponseItem","signature":[{"pluginId":"bfetch","scope":"common","docId":"kibBfetchPluginApi","section":"def-common.BatchResponseItem","text":"BatchResponseItem"},""],"description":[],"children":[{"id":"def-common.BatchResponseItem.id","type":"number","label":"id","description":[],"source":{"path":"src/plugins/bfetch/common/batch.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/batch.ts#L18"}},{"id":"def-common.BatchResponseItem.result","type":"Uncategorized","label":"result","description":[],"source":{"path":"src/plugins/bfetch/common/batch.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/batch.ts#L19"},"signature":["Result | undefined"]},{"id":"def-common.BatchResponseItem.error","type":"Uncategorized","label":"error","description":[],"source":{"path":"src/plugins/bfetch/common/batch.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/batch.ts#L20"},"signature":["Error | undefined"]}],"source":{"path":"src/plugins/bfetch/common/batch.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/bfetch/common/batch.ts#L17"},"initialIsOpen":false}],"enums":[],"misc":[],"objects":[]}} \ No newline at end of file diff --git a/api_docs/bfetch.mdx b/api_docs/bfetch.mdx new file mode 100644 index 0000000000000..4f566ba6ae767 --- /dev/null +++ b/api_docs/bfetch.mdx @@ -0,0 +1,38 @@ +--- +id: kibBfetchPluginApi +slug: /kibana-dev-docs/bfetchPluginApi +title: bfetch +image: https://source.unsplash.com/400x175/?github +summary: API docs for the bfetch plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'bfetch'] +--- + +import bfetchObj from './bfetch.json'; + +## Client + +### Start + +### Functions + +### Consts, variables and types + +## Server + +### Setup + +### Start + +### Interfaces + +### Consts, variables and types + +## Common + +### Functions + +### Classes + +### Interfaces + diff --git a/api_docs/canvas.json b/api_docs/canvas.json new file mode 100644 index 0000000000000..37a42d5eac05b --- /dev/null +++ b/api_docs/canvas.json @@ -0,0 +1 @@ +{"id":"canvas","client":{"classes":[],"functions":[],"interfaces":[{"id":"def-public.WithKibanaProps","type":"Interface","label":"WithKibanaProps","description":[],"children":[{"id":"def-public.WithKibanaProps.kibana","type":"Object","label":"kibana","description":[],"source":{"path":"x-pack/plugins/canvas/public/index.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/canvas/public/index.ts#L16"},"signature":["{ services: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreStart","text":"CoreStart"}," & ",{"pluginId":"canvas","scope":"public","docId":"kibCanvasPluginApi","section":"def-public.CanvasStartDeps","text":"CanvasStartDeps"}," & { canvas: ",{"pluginId":"canvas","scope":"public","docId":"kibCanvasPluginApi","section":"def-public.CanvasServices","text":"CanvasServices"},"; }; }"]}],"source":{"path":"x-pack/plugins/canvas/public/index.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/canvas/public/index.ts#L15"},"initialIsOpen":false}],"enums":[],"misc":[],"objects":[],"setup":{"id":"def-public.CanvasSetup","type":"Type","label":"CanvasSetup","description":["\nThese are the interfaces with your public contracts. You should export these\nfor other plugins to use in _their_ `SetupDeps`/`StartDeps` interfaces."],"source":{"path":"x-pack/plugins/canvas/public/plugin.tsx","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/canvas/public/plugin.tsx#L63"},"signature":["CanvasApi"],"lifecycle":"setup","initialIsOpen":true},"start":{"id":"def-public.CanvasStart","type":"Type","label":"CanvasStart","description":[],"source":{"path":"x-pack/plugins/canvas/public/plugin.tsx","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/canvas/public/plugin.tsx#L64"},"signature":["void"],"lifecycle":"start","initialIsOpen":true}},"server":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]}} \ No newline at end of file diff --git a/api_docs/canvas.mdx b/api_docs/canvas.mdx new file mode 100644 index 0000000000000..e0ed026d9f002 --- /dev/null +++ b/api_docs/canvas.mdx @@ -0,0 +1,20 @@ +--- +id: kibCanvasPluginApi +slug: /kibana-dev-docs/canvasPluginApi +title: canvas +image: https://source.unsplash.com/400x175/?github +summary: API docs for the canvas plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'canvas'] +--- + +import canvasObj from './canvas.json'; + +## Client + +### Setup + +### Start + +### Interfaces + diff --git a/api_docs/case.json b/api_docs/case.json new file mode 100644 index 0000000000000..3c98596e12040 --- /dev/null +++ b/api_docs/case.json @@ -0,0 +1 @@ +{"id":"case","client":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"server":{"classes":[],"functions":[],"interfaces":[{"id":"def-server.CaseRequestContext","type":"Interface","label":"CaseRequestContext","description":[],"children":[{"id":"def-server.CaseRequestContext.getCaseClient","type":"Function","label":"getCaseClient","description":[],"source":{"path":"x-pack/plugins/case/server/types.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/case/server/types.ts#L14"},"signature":["() => ",{"pluginId":"case","scope":"server","docId":"kibCasePluginApi","section":"def-server.CaseClient","text":"CaseClient"}]}],"source":{"path":"x-pack/plugins/case/server/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/case/server/types.ts#L13"},"initialIsOpen":false}],"enums":[],"misc":[],"objects":[]},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]}} \ No newline at end of file diff --git a/api_docs/case.mdx b/api_docs/case.mdx new file mode 100644 index 0000000000000..43aa1987b4680 --- /dev/null +++ b/api_docs/case.mdx @@ -0,0 +1,16 @@ +--- +id: kibCasePluginApi +slug: /kibana-dev-docs/casePluginApi +title: case +image: https://source.unsplash.com/400x175/?github +summary: API docs for the case plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'case'] +--- + +import caseObj from './case.json'; + +## Server + +### Interfaces + diff --git a/api_docs/charts.json b/api_docs/charts.json new file mode 100644 index 0000000000000..d1ae80b6a6a2a --- /dev/null +++ b/api_docs/charts.json @@ -0,0 +1 @@ +{"id":"charts","client":{"classes":[],"functions":[{"id":"def-public.getHeatmapColors","type":"Function","label":"getHeatmapColors","signature":["(value: any, colorSchemaName: string) => string"],"description":[],"children":[{"type":"Any","label":"value","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/charts/public/static/color_maps/heatmap_color.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/heatmap_color.ts#L47"}},{"type":"string","label":"colorSchemaName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/charts/public/static/color_maps/heatmap_color.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/heatmap_color.ts#L47"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/charts/public/static/color_maps/heatmap_color.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/heatmap_color.ts#L47"},"initialIsOpen":false},{"id":"def-public.createColorPalette","type":"Function","label":"createColorPalette","signature":["(num: number) => string[]"],"description":["\nGenerates an array of hex colors the length of the input number.\nIf the number is greater than the length of seed colors available,\nnew colors are generated up to the value of the input number."],"children":[{"type":"number","label":"num","isRequired":true,"signature":["number"],"description":[],"source":{"path":"src/plugins/charts/public/static/colors/color_palette.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/colors/color_palette.ts#L41"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/charts/public/static/colors/color_palette.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/colors/color_palette.ts#L41"},"initialIsOpen":false},{"id":"def-public.LegendToggle","type":"Function","label":"LegendToggle","description":[],"source":{"path":"src/plugins/charts/public/static/components/legend_toggle.tsx","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/legend_toggle.tsx#L51"},"signature":["React.MemoExoticComponent<({ onClick, showLegend, legendPosition }: LegendToggleProps) => JSX.Element>"],"initialIsOpen":false},{"id":"def-public.ColorPicker","type":"Function","children":[{"type":"Object","label":"{ onChange, color: selectedColor, id, label }","isRequired":true,"signature":["ColorPickerProps"],"description":[],"source":{"path":"src/plugins/charts/public/static/components/color_picker.tsx","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/color_picker.tsx#L83"}}],"signature":["({ onChange, color: selectedColor, id, label }: ColorPickerProps) => JSX.Element"],"description":[],"label":"ColorPicker","source":{"path":"src/plugins/charts/public/static/components/color_picker.tsx","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/color_picker.tsx#L83"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.CurrentTime","type":"Function","children":[{"type":"CompoundType","label":"{ isDarkMode, domainEnd }","isRequired":true,"signature":["React.PropsWithChildren"],"description":[],"source":{"path":"src/plugins/charts/public/static/components/current_time.tsx","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/current_time.tsx#L24"}}],"signature":["({ isDarkMode, domainEnd }: React.PropsWithChildren) => JSX.Element"],"description":["\nRender current time line annotation on @elastic/charts `Chart`"],"label":"CurrentTime","source":{"path":"src/plugins/charts/public/static/components/current_time.tsx","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/current_time.tsx#L24"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.Endzones","type":"Function","children":[{"type":"CompoundType","label":"{\n isDarkMode,\n domainStart,\n domainEnd,\n interval,\n domainMin,\n domainMax,\n hideTooltips = true,\n isFullBin = false,\n}","isRequired":true,"signature":["React.PropsWithChildren"],"description":[],"source":{"path":"src/plugins/charts/public/static/components/endzones.tsx","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L37"}}],"signature":["({ isDarkMode, domainStart, domainEnd, interval, domainMin, domainMax, hideTooltips, isFullBin, }: React.PropsWithChildren) => JSX.Element"],"description":[],"label":"Endzones","source":{"path":"src/plugins/charts/public/static/components/endzones.tsx","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L37"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.getAdjustedInterval","type":"Function","children":[{"type":"Array","label":"xValues","isRequired":true,"signature":["number[]"],"description":[],"source":{"path":"src/plugins/charts/public/static/components/endzones.tsx","lineNumber":121,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L121"}},{"type":"number","label":"esValue","isRequired":true,"signature":["number"],"description":[],"source":{"path":"src/plugins/charts/public/static/components/endzones.tsx","lineNumber":122,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L122"}},{"type":"CompoundType","label":"esUnit","isRequired":true,"signature":["moment.unitOfTime.Base"],"description":[],"source":{"path":"src/plugins/charts/public/static/components/endzones.tsx","lineNumber":123,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L123"}},{"type":"string","label":"timeZone","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/charts/public/static/components/endzones.tsx","lineNumber":124,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L124"}}],"signature":["(xValues: number[], esValue: number, esUnit: moment.unitOfTime.Base, timeZone: string) => number"],"description":["\nReturns the adjusted interval based on the data\n"],"label":"getAdjustedInterval","source":{"path":"src/plugins/charts/public/static/components/endzones.tsx","lineNumber":120,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L120"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.renderEndzoneTooltip","type":"Function","children":[{"type":"number","label":"xInterval","isRequired":false,"signature":["number | undefined"],"description":[],"source":{"path":"src/plugins/charts/public/static/components/endzones.tsx","lineNumber":160,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L160"}},{"type":"number","label":"domainStart","isRequired":false,"signature":["number | undefined"],"description":[],"source":{"path":"src/plugins/charts/public/static/components/endzones.tsx","lineNumber":161,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L161"}},{"type":"number","label":"domainEnd","isRequired":false,"signature":["number | undefined"],"description":[],"source":{"path":"src/plugins/charts/public/static/components/endzones.tsx","lineNumber":162,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L162"}},{"type":"Function","label":"formatter","isRequired":false,"signature":["((v: any) => string) | undefined"],"description":[],"source":{"path":"src/plugins/charts/public/static/components/endzones.tsx","lineNumber":163,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L163"}},{"type":"boolean","label":"renderValue","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/charts/public/static/components/endzones.tsx","lineNumber":164,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L164"}}],"signature":["(xInterval?: number | undefined, domainStart?: number | undefined, domainEnd?: number | undefined, formatter?: ((v: any) => string) | undefined, renderValue?: boolean) => (headerData: ","TooltipValue",") => string | JSX.Element"],"description":[],"label":"renderEndzoneTooltip","source":{"path":"src/plugins/charts/public/static/components/endzones.tsx","lineNumber":159,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/endzones.tsx#L159"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.getFilterFromChartClickEventFn","type":"Function","children":[{"type":"Object","label":"table","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"}],"description":[],"source":{"path":"src/plugins/charts/public/static/utils/transform_click_event.ts","lineNumber":172,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L172"}},{"type":"CompoundType","label":"xAccessor","isRequired":true,"signature":["string | number | ","AccessorFn"],"description":[],"source":{"path":"src/plugins/charts/public/static/utils/transform_click_event.ts","lineNumber":173,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L173"}},{"type":"Object","label":"splitSeriesAccessorFnMap","isRequired":false,"signature":["Map | undefined"],"description":[],"source":{"path":"src/plugins/charts/public/static/utils/transform_click_event.ts","lineNumber":174,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L174"}},{"type":"CompoundType","label":"splitChartAccessor","isRequired":false,"signature":["string | number | ","AccessorFn"," | undefined"],"description":[],"source":{"path":"src/plugins/charts/public/static/utils/transform_click_event.ts","lineNumber":175,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L175"}},{"type":"boolean","label":"negate","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/charts/public/static/utils/transform_click_event.ts","lineNumber":176,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L176"}}],"signature":["(table: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"},", xAccessor: string | number | ","AccessorFn",", splitSeriesAccessorFnMap?: Map | undefined, splitChartAccessor?: string | number | ","AccessorFn"," | undefined, negate?: boolean) => (points: [","GeometryValue"],"description":["\nHelper function to transform `@elastic/charts` click event into filter action event\n"],"label":"getFilterFromChartClickEventFn","source":{"path":"src/plugins/charts/public/static/utils/transform_click_event.ts","lineNumber":171,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L171"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.getFilterFromSeriesFn","type":"Function","children":[{"type":"Object","label":"table","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"}],"description":[],"source":{"path":"src/plugins/charts/public/static/utils/transform_click_event.ts","lineNumber":220,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L220"}}],"signature":["(table: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"},") => ({ splitAccessors, ...rest }: ","XYChartSeriesIdentifier",", splitSeriesAccessorFnMap?: Map | undefined, splitChartAccessor?: string | number | ","AccessorFn"," | undefined, negate?: boolean) => ",{"pluginId":"charts","scope":"public","docId":"kibChartsPluginApi","section":"def-public.ClickTriggerEvent","text":"ClickTriggerEvent"}],"description":["\nHelper function to get filter action event from series"],"label":"getFilterFromSeriesFn","source":{"path":"src/plugins/charts/public/static/utils/transform_click_event.ts","lineNumber":220,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L220"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.getBrushFromChartBrushEventFn","type":"Function","children":[{"type":"Object","label":"table","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"}],"description":[],"source":{"path":"src/plugins/charts/public/static/utils/transform_click_event.ts","lineNumber":255,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L255"}},{"type":"CompoundType","label":"xAccessor","isRequired":true,"signature":["string | number | ","AccessorFn"],"description":[],"source":{"path":"src/plugins/charts/public/static/utils/transform_click_event.ts","lineNumber":256,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L256"}}],"signature":["(table: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"},", xAccessor: string | number | ","AccessorFn",") => ({ x: selectedRange }: ","XYBrushArea",") => ",{"pluginId":"charts","scope":"public","docId":"kibChartsPluginApi","section":"def-public.BrushTriggerEvent","text":"BrushTriggerEvent"}],"description":["\nHelper function to transform `@elastic/charts` brush event into brush action event"],"label":"getBrushFromChartBrushEventFn","source":{"path":"src/plugins/charts/public/static/utils/transform_click_event.ts","lineNumber":254,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L254"},"returnComment":[],"initialIsOpen":false}],"interfaces":[{"id":"def-public.PaletteOutput","type":"Interface","label":"PaletteOutput","signature":[{"pluginId":"charts","scope":"common","docId":"kibChartsPluginApi","section":"def-common.PaletteOutput","text":"PaletteOutput"},""],"description":[],"children":[{"id":"def-public.PaletteOutput.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/charts/common/palette.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L29"},"signature":["\"palette\""]},{"id":"def-public.PaletteOutput.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/charts/common/palette.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L30"}},{"id":"def-public.PaletteOutput.params","type":"Uncategorized","label":"params","description":[],"source":{"path":"src/plugins/charts/common/palette.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L31"},"signature":["T | undefined"]}],"source":{"path":"src/plugins/charts/common/palette.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L28"},"initialIsOpen":false},{"id":"def-public.CustomPaletteArguments","type":"Interface","label":"CustomPaletteArguments","description":[],"children":[{"id":"def-public.CustomPaletteArguments.color","type":"Array","label":"color","description":[],"source":{"path":"src/plugins/charts/common/palette.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L14"},"signature":["string[] | undefined"]},{"id":"def-public.CustomPaletteArguments.gradient","type":"boolean","label":"gradient","description":[],"source":{"path":"src/plugins/charts/common/palette.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L15"}},{"id":"def-public.CustomPaletteArguments.reverse","type":"CompoundType","label":"reverse","description":[],"source":{"path":"src/plugins/charts/common/palette.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L16"},"signature":["boolean | undefined"]}],"source":{"path":"src/plugins/charts/common/palette.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L13"},"initialIsOpen":false},{"id":"def-public.CustomPaletteState","type":"Interface","label":"CustomPaletteState","description":[],"children":[{"id":"def-public.CustomPaletteState.colors","type":"Array","label":"colors","description":[],"source":{"path":"src/plugins/charts/common/palette.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L20"},"signature":["string[]"]},{"id":"def-public.CustomPaletteState.gradient","type":"boolean","label":"gradient","description":[],"source":{"path":"src/plugins/charts/common/palette.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L21"}}],"source":{"path":"src/plugins/charts/common/palette.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L19"},"initialIsOpen":false},{"id":"def-public.SystemPaletteArguments","type":"Interface","label":"SystemPaletteArguments","description":[],"children":[{"id":"def-public.SystemPaletteArguments.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/charts/common/palette.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L25"}}],"source":{"path":"src/plugins/charts/common/palette.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L24"},"initialIsOpen":false},{"id":"def-public.ColorSchema","type":"Interface","label":"ColorSchema","description":[],"children":[{"id":"def-public.ColorSchema.value","type":"Enum","label":"value","description":[],"source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L21"},"signature":[{"pluginId":"charts","scope":"public","docId":"kibChartsPluginApi","section":"def-public.ColorSchemas","text":"ColorSchemas"}]},{"id":"def-public.ColorSchema.text","type":"string","label":"text","description":[],"source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L22"}}],"source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L20"},"initialIsOpen":false},{"id":"def-public.RawColorSchema","type":"Interface","label":"RawColorSchema","description":[],"children":[{"id":"def-public.RawColorSchema.id","type":"Enum","label":"id","description":[],"source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L26"},"signature":[{"pluginId":"charts","scope":"public","docId":"kibChartsPluginApi","section":"def-public.ColorSchemas","text":"ColorSchemas"}]},{"id":"def-public.RawColorSchema.label","type":"string","label":"label","description":[],"source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L27"}},{"id":"def-public.RawColorSchema.value","type":"Array","label":"value","description":[],"source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L28"},"signature":["[number, number[]][]"]}],"source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L25"},"initialIsOpen":false},{"id":"def-public.ColorMap","type":"Interface","label":"ColorMap","description":[],"children":[{"id":"def-public.ColorMap.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L32"},"signature":["any"]}],"source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L31"},"initialIsOpen":false},{"id":"def-public.ColorSchemaParams","type":"Interface","label":"ColorSchemaParams","description":[],"children":[{"id":"def-public.ColorSchemaParams.colorSchema","type":"Enum","label":"colorSchema","description":[],"source":{"path":"src/plugins/charts/public/static/components/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L13"},"signature":[{"pluginId":"charts","scope":"public","docId":"kibChartsPluginApi","section":"def-public.ColorSchemas","text":"ColorSchemas"}]},{"id":"def-public.ColorSchemaParams.invertColors","type":"boolean","label":"invertColors","description":[],"source":{"path":"src/plugins/charts/public/static/components/types.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L14"}}],"source":{"path":"src/plugins/charts/public/static/components/types.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L12"},"initialIsOpen":false},{"id":"def-public.Labels","type":"Interface","label":"Labels","description":[],"children":[{"id":"def-public.Labels.color","type":"string","label":"color","description":[],"source":{"path":"src/plugins/charts/public/static/components/types.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L18"},"signature":["string | undefined"]},{"id":"def-public.Labels.filter","type":"CompoundType","label":"filter","description":[],"source":{"path":"src/plugins/charts/public/static/components/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L19"},"signature":["boolean | undefined"]},{"id":"def-public.Labels.overwriteColor","type":"CompoundType","label":"overwriteColor","description":[],"source":{"path":"src/plugins/charts/public/static/components/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L20"},"signature":["boolean | undefined"]},{"id":"def-public.Labels.rotate","type":"number","label":"rotate","description":[],"source":{"path":"src/plugins/charts/public/static/components/types.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L21"},"signature":["number | undefined"]},{"id":"def-public.Labels.show","type":"CompoundType","label":"show","description":[],"source":{"path":"src/plugins/charts/public/static/components/types.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L22"},"signature":["boolean | undefined"]},{"id":"def-public.Labels.truncate","type":"CompoundType","label":"truncate","description":[],"source":{"path":"src/plugins/charts/public/static/components/types.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L23"},"signature":["number | null | undefined"]}],"source":{"path":"src/plugins/charts/public/static/components/types.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L17"},"initialIsOpen":false},{"id":"def-public.Style","type":"Interface","label":"Style","description":[],"children":[{"id":"def-public.Style.bgFill","type":"string","label":"bgFill","description":[],"source":{"path":"src/plugins/charts/public/static/components/types.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L27"}},{"id":"def-public.Style.bgColor","type":"boolean","label":"bgColor","description":[],"source":{"path":"src/plugins/charts/public/static/components/types.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L28"}},{"id":"def-public.Style.labelColor","type":"boolean","label":"labelColor","description":[],"source":{"path":"src/plugins/charts/public/static/components/types.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L29"}},{"id":"def-public.Style.subText","type":"string","label":"subText","description":[],"source":{"path":"src/plugins/charts/public/static/components/types.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L30"}},{"id":"def-public.Style.fontSize","type":"number","label":"fontSize","description":[],"source":{"path":"src/plugins/charts/public/static/components/types.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L31"}}],"source":{"path":"src/plugins/charts/public/static/components/types.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/types.ts#L26"},"initialIsOpen":false},{"id":"def-public.ClickTriggerEvent","type":"Interface","label":"ClickTriggerEvent","description":[],"children":[{"id":"def-public.ClickTriggerEvent.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/charts/public/static/utils/transform_click_event.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L22"},"signature":["\"filterBucket\""]},{"id":"def-public.ClickTriggerEvent.data","type":"Object","label":"data","description":[],"source":{"path":"src/plugins/charts/public/static/utils/transform_click_event.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L23"},"signature":["{ data: { table: Pick<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"},", \"rows\" | \"columns\">; column: number; row: number; value: any; }[]; timeFieldName?: string | undefined; negate?: boolean | undefined; }"]}],"source":{"path":"src/plugins/charts/public/static/utils/transform_click_event.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L21"},"initialIsOpen":false},{"id":"def-public.BrushTriggerEvent","type":"Interface","label":"BrushTriggerEvent","description":[],"children":[{"id":"def-public.BrushTriggerEvent.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/charts/public/static/utils/transform_click_event.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L27"},"signature":["\"brush\""]},{"id":"def-public.BrushTriggerEvent.data","type":"Object","label":"data","description":[],"source":{"path":"src/plugins/charts/public/static/utils/transform_click_event.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L28"},"signature":["{ table: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"},"; column: number; range: number[]; timeFieldName?: string | undefined; }"]}],"source":{"path":"src/plugins/charts/public/static/utils/transform_click_event.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/utils/transform_click_event.ts#L26"},"initialIsOpen":false},{"id":"def-public.SeriesLayer","type":"Interface","label":"SeriesLayer","description":["\nInformation about a series in a chart used to determine its color.\nSeries layers can be nested, this means each series layer can have an ancestor."],"children":[{"id":"def-public.SeriesLayer.name","type":"string","label":"name","description":["\nName of the series (can be used for lookup-based coloring)"],"source":{"path":"src/plugins/charts/public/services/palettes/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L19"}},{"id":"def-public.SeriesLayer.rankAtDepth","type":"number","label":"rankAtDepth","description":["\nRank of the series compared to siblings with the same ancestor"],"source":{"path":"src/plugins/charts/public/services/palettes/types.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L23"}},{"id":"def-public.SeriesLayer.totalSeriesAtDepth","type":"number","label":"totalSeriesAtDepth","description":["\nTotal number of series with the same ancestor"],"source":{"path":"src/plugins/charts/public/services/palettes/types.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L27"}}],"source":{"path":"src/plugins/charts/public/services/palettes/types.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L15"},"initialIsOpen":false},{"id":"def-public.ChartColorConfiguration","type":"Interface","label":"ChartColorConfiguration","description":["\nInformation about the structure of a chart to determine the color of a series within it."],"children":[{"id":"def-public.ChartColorConfiguration.totalSeries","type":"number","label":"totalSeries","description":["\nOverall number of series in the current chart"],"source":{"path":"src/plugins/charts/public/services/palettes/types.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L37"},"signature":["number | undefined"]},{"id":"def-public.ChartColorConfiguration.maxDepth","type":"number","label":"maxDepth","description":["\nMax nesting depth of the series tree"],"source":{"path":"src/plugins/charts/public/services/palettes/types.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L41"},"signature":["number | undefined"]},{"id":"def-public.ChartColorConfiguration.behindText","type":"CompoundType","label":"behindText","description":["\nFlag whether the color will be used behind text. The palette can use this information to\nadjust colors for better a11y. Might be ignored depending on the palette."],"source":{"path":"src/plugins/charts/public/services/palettes/types.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L46"},"signature":["boolean | undefined"]},{"id":"def-public.ChartColorConfiguration.syncColors","type":"CompoundType","label":"syncColors","description":["\nFlag whether a color assignment to a given key should be remembered and re-used the next time the key shows up.\nThis setting might be ignored based on the palette."],"source":{"path":"src/plugins/charts/public/services/palettes/types.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L51"},"signature":["boolean | undefined"]}],"source":{"path":"src/plugins/charts/public/services/palettes/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L33"},"initialIsOpen":false},{"id":"def-public.PaletteDefinition","type":"Interface","label":"PaletteDefinition","signature":[{"pluginId":"charts","scope":"public","docId":"kibChartsPluginApi","section":"def-public.PaletteDefinition","text":"PaletteDefinition"},""],"description":["\nDefinition of a global palette.\n\nA palette controls the appearance of Lens charts on an editor level.\nThe palette wont get reset when switching charts.\n\nA palette can hold internal state (e.g. for customizations) and also includes\nan editor component to edit the internal state."],"children":[{"id":"def-public.PaletteDefinition.id","type":"string","label":"id","description":["\nUnique id of the palette (this will be persisted along with the visualization state)"],"source":{"path":"src/plugins/charts/public/services/palettes/types.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L67"}},{"id":"def-public.PaletteDefinition.title","type":"string","label":"title","description":["\nUser facing title (should be i18n-ized)"],"source":{"path":"src/plugins/charts/public/services/palettes/types.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L71"}},{"id":"def-public.PaletteDefinition.internal","type":"CompoundType","label":"internal","description":["\nFlag indicating whether users should be able to pick this palette manually."],"source":{"path":"src/plugins/charts/public/services/palettes/types.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L75"},"signature":["boolean | undefined"]},{"id":"def-public.PaletteDefinition.toExpression","type":"Function","label":"toExpression","description":["\nSerialize the internal state of the palette into an expression function.\nThis function should be used to pass the palette to the expression function applying color and other styles"],"source":{"path":"src/plugins/charts/public/services/palettes/types.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L81"},"signature":["(state?: T | undefined) => ","Ast"]},{"id":"def-public.PaletteDefinition.renderEditor","type":"Function","label":"renderEditor","description":["\nRenders the UI for editing the internal state of the palette.\nNot each palette has to feature an internal state, so this is an optional property."],"source":{"path":"src/plugins/charts/public/services/palettes/types.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L88"},"signature":["((domElement: Element, props: { state?: T | undefined; setState: (updater: (oldState: T) => T) => void; }) => void) | undefined"]},{"id":"def-public.PaletteDefinition.getColor","type":"Function","label":"getColor","description":["\nColor a series according to the internal rules of the palette."],"source":{"path":"src/plugins/charts/public/services/palettes/types.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L97"},"signature":["(series: ",{"pluginId":"charts","scope":"public","docId":"kibChartsPluginApi","section":"def-public.SeriesLayer","text":"SeriesLayer"},"[], chartConfiguration?: ",{"pluginId":"charts","scope":"public","docId":"kibChartsPluginApi","section":"def-public.ChartColorConfiguration","text":"ChartColorConfiguration"}," | undefined, state?: T | undefined) => string | null"]},{"id":"def-public.PaletteDefinition.getColors","type":"Function","label":"getColors","description":["\nGet a spectrum of colors of the current palette.\nThis can be used if the chart wants to control color assignment locally."],"source":{"path":"src/plugins/charts/public/services/palettes/types.ts","lineNumber":106,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L106"},"signature":["(size: number, state?: T | undefined) => string[]"]}],"source":{"path":"src/plugins/charts/public/services/palettes/types.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L63"},"initialIsOpen":false},{"id":"def-public.PaletteRegistry","type":"Interface","label":"PaletteRegistry","description":[],"children":[{"id":"def-public.PaletteRegistry.get","type":"Function","label":"get","description":[],"source":{"path":"src/plugins/charts/public/services/palettes/types.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L110"},"signature":["(name: string) => ",{"pluginId":"charts","scope":"public","docId":"kibChartsPluginApi","section":"def-public.PaletteDefinition","text":"PaletteDefinition"},""]},{"id":"def-public.PaletteRegistry.getAll","type":"Function","label":"getAll","description":[],"source":{"path":"src/plugins/charts/public/services/palettes/types.ts","lineNumber":111,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L111"},"signature":["() => ",{"pluginId":"charts","scope":"public","docId":"kibChartsPluginApi","section":"def-public.PaletteDefinition","text":"PaletteDefinition"},"[]"]}],"source":{"path":"src/plugins/charts/public/services/palettes/types.ts","lineNumber":109,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/services/palettes/types.ts#L109"},"initialIsOpen":false}],"enums":[{"id":"def-public.ColorSchemas","type":"Enum","label":"ColorSchemas","description":[],"source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L11"},"initialIsOpen":false}],"misc":[{"id":"def-public.paletteIds","type":"Array","label":"paletteIds","description":[],"source":{"path":"src/plugins/charts/common/constants.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/constants.ts#L10"},"signature":["string[]"],"initialIsOpen":false},{"id":"def-public.colorSchemas","type":"Array","label":"colorSchemas","description":[],"source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":3160,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L3160"},"signature":[{"pluginId":"charts","scope":"public","docId":"kibChartsPluginApi","section":"def-public.ColorSchema","text":"ColorSchema"},"[]"],"initialIsOpen":false},{"id":"def-public.truncatedColorSchemas","type":"Array","label":"truncatedColorSchemas","description":[],"source":{"path":"src/plugins/charts/public/static/color_maps/truncated_color_maps.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/truncated_color_maps.ts#L26"},"signature":[{"pluginId":"charts","scope":"public","docId":"kibChartsPluginApi","section":"def-public.ColorSchema","text":"ColorSchema"},"[]"],"initialIsOpen":false},{"id":"def-public.seedColors","type":"Array","label":"seedColors","description":["\nUsing a random color generator presented awful colors and unpredictable color schemes.\nSo we needed to come up with a color scheme of our own that creates consistent, pleasing color patterns.\nThe order allows us to guarantee that 1st, 2nd, 3rd, etc values always get the same color."],"source":{"path":"src/plugins/charts/public/static/colors/seed_colors.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/colors/seed_colors.ts#L14"},"signature":["string[]"],"initialIsOpen":false},{"id":"def-public.ColorMode","type":"Type","label":"ColorMode","description":[],"source":{"path":"src/plugins/charts/public/static/components/collections.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/collections.ts#L17"},"signature":["\"Background\" | \"Labels\" | \"None\""],"initialIsOpen":false},{"id":"def-public.LabelRotation","type":"Type","label":"LabelRotation","description":[],"source":{"path":"src/plugins/charts/public/static/components/collections.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/collections.ts#L24"},"signature":["{ readonly Horizontal: number; readonly Vertical: number; readonly Angled: number; } number"],"initialIsOpen":false},{"id":"def-public.defaultCountLabel","type":"string","label":"defaultCountLabel","description":[],"source":{"path":"src/plugins/charts/public/static/components/collections.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/collections.ts#L26"},"initialIsOpen":false}],"objects":[{"id":"def-public.vislibColorMaps","type":"Object","children":[{"id":"def-public.vislibColorMaps.[ColorSchemas.Blues]","type":"Object","children":[{"id":"def-public.vislibColorMaps.[ColorSchemas.Blues].id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L38"},"signature":[{"pluginId":"charts","scope":"public","docId":"kibChartsPluginApi","section":"def-public.ColorSchemas","text":"ColorSchemas"},".Blues"]},{"id":"def-public.vislibColorMaps.[ColorSchemas.Blues].label","type":"string","label":"label","description":[],"source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L39"}},{"id":"def-public.vislibColorMaps.[ColorSchemas.Blues].value","type":"Array","label":"value","description":[],"source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L42"},"signature":["[number, number[]][]"]}],"description":["// Sequential"],"label":"[ColorSchemas.Blues]","source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L37"}},{"id":"def-public.vislibColorMaps.[ColorSchemas.Greens]","type":"Object","children":[{"id":"def-public.vislibColorMaps.[ColorSchemas.Greens].id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":558,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L558"},"signature":[{"pluginId":"charts","scope":"public","docId":"kibChartsPluginApi","section":"def-public.ColorSchemas","text":"ColorSchemas"},".Greens"]},{"id":"def-public.vislibColorMaps.[ColorSchemas.Greens].label","type":"string","label":"label","description":[],"source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":559,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L559"}},{"id":"def-public.vislibColorMaps.[ColorSchemas.Greens].value","type":"Array","label":"value","description":[],"source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":562,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L562"},"signature":["[number, number[]][]"]}],"description":[],"label":"[ColorSchemas.Greens]","source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":557,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L557"}},{"id":"def-public.vislibColorMaps.[ColorSchemas.Greys]","type":"Object","children":[{"id":"def-public.vislibColorMaps.[ColorSchemas.Greys].id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":1078,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L1078"},"signature":[{"pluginId":"charts","scope":"public","docId":"kibChartsPluginApi","section":"def-public.ColorSchemas","text":"ColorSchemas"},".Greys"]},{"id":"def-public.vislibColorMaps.[ColorSchemas.Greys].label","type":"string","label":"label","description":[],"source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":1079,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L1079"}},{"id":"def-public.vislibColorMaps.[ColorSchemas.Greys].value","type":"Array","label":"value","description":[],"source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":1082,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L1082"},"signature":["[number, number[]][]"]}],"description":[],"label":"[ColorSchemas.Greys]","source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":1077,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L1077"}},{"id":"def-public.vislibColorMaps.[ColorSchemas.Reds]","type":"Object","children":[{"id":"def-public.vislibColorMaps.[ColorSchemas.Reds].id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":1598,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L1598"},"signature":[{"pluginId":"charts","scope":"public","docId":"kibChartsPluginApi","section":"def-public.ColorSchemas","text":"ColorSchemas"},".Reds"]},{"id":"def-public.vislibColorMaps.[ColorSchemas.Reds].label","type":"string","label":"label","description":[],"source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":1599,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L1599"}},{"id":"def-public.vislibColorMaps.[ColorSchemas.Reds].value","type":"Array","label":"value","description":[],"source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":1602,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L1602"},"signature":["[number, number[]][]"]}],"description":[],"label":"[ColorSchemas.Reds]","source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":1597,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L1597"}},{"id":"def-public.vislibColorMaps.[ColorSchemas.YellowToRed]","type":"Object","children":[{"id":"def-public.vislibColorMaps.[ColorSchemas.YellowToRed].id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":2118,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L2118"},"signature":[{"pluginId":"charts","scope":"public","docId":"kibChartsPluginApi","section":"def-public.ColorSchemas","text":"ColorSchemas"},".YellowToRed"]},{"id":"def-public.vislibColorMaps.[ColorSchemas.YellowToRed].label","type":"string","label":"label","description":[],"source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":2119,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L2119"}},{"id":"def-public.vislibColorMaps.[ColorSchemas.YellowToRed].value","type":"Array","label":"value","description":[],"source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":2122,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L2122"},"signature":["[number, number[]][]"]}],"description":[],"label":"[ColorSchemas.YellowToRed]","source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":2117,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L2117"}},{"id":"def-public.vislibColorMaps.[ColorSchemas.GreenToRed]","type":"Object","children":[{"id":"def-public.vislibColorMaps.[ColorSchemas.GreenToRed].id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":2639,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L2639"},"signature":[{"pluginId":"charts","scope":"public","docId":"kibChartsPluginApi","section":"def-public.ColorSchemas","text":"ColorSchemas"},".GreenToRed"]},{"id":"def-public.vislibColorMaps.[ColorSchemas.GreenToRed].label","type":"string","label":"label","description":[],"source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":2640,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L2640"}},{"id":"def-public.vislibColorMaps.[ColorSchemas.GreenToRed].value","type":"Array","label":"value","description":[],"source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":2643,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L2643"},"signature":["[number, number[]][]"]}],"description":[],"label":"[ColorSchemas.GreenToRed]","source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":2638,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L2638"}}],"description":[],"label":"vislibColorMaps","source":{"path":"src/plugins/charts/public/static/color_maps/color_maps.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/color_maps.ts#L35"},"initialIsOpen":false},{"id":"def-public.truncatedColorMaps","type":"Object","children":[],"description":[],"label":"truncatedColorMaps","source":{"path":"src/plugins/charts/public/static/color_maps/truncated_color_maps.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/color_maps/truncated_color_maps.ts#L11"},"initialIsOpen":false},{"id":"def-public.ColorMode","type":"Object","label":"ColorMode","description":[],"source":{"path":"src/plugins/charts/public/static/components/collections.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/collections.ts#L12"},"signature":["Readonly<{ Background: \"Background\"; Labels: \"Labels\"; None: \"None\"; }>"],"initialIsOpen":false},{"id":"def-public.LabelRotation","type":"Object","label":"LabelRotation","description":[],"source":{"path":"src/plugins/charts/public/static/components/collections.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/static/components/collections.ts#L19"},"signature":["Readonly<{ Horizontal: number; Vertical: number; Angled: number; }>"],"initialIsOpen":false}],"start":{"id":"def-public.ChartsPluginStart","type":"Type","label":"ChartsPluginStart","description":[],"source":{"path":"src/plugins/charts/public/plugin.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/public/plugin.ts#L31"},"signature":["ChartsPluginSetup"],"lifecycle":"start","initialIsOpen":true}},"server":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"common":{"classes":[],"functions":[{"id":"def-common.palette","type":"Function","label":"palette","signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunctionDefinition","text":"ExpressionFunctionDefinition"},"<\"palette\", null, ",{"pluginId":"charts","scope":"common","docId":"kibChartsPluginApi","section":"def-common.CustomPaletteArguments","text":"CustomPaletteArguments"},", ",{"pluginId":"charts","scope":"common","docId":"kibChartsPluginApi","section":"def-common.PaletteOutput","text":"PaletteOutput"},"<",{"pluginId":"charts","scope":"common","docId":"kibChartsPluginApi","section":"def-common.CustomPaletteState","text":"CustomPaletteState"},">, ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"}],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/charts/common/palette.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L53"},"initialIsOpen":false},{"id":"def-common.systemPalette","type":"Function","label":"systemPalette","signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunctionDefinition","text":"ExpressionFunctionDefinition"},"<\"system_palette\", null, ",{"pluginId":"charts","scope":"common","docId":"kibChartsPluginApi","section":"def-common.SystemPaletteArguments","text":"SystemPaletteArguments"},", ",{"pluginId":"charts","scope":"common","docId":"kibChartsPluginApi","section":"def-common.PaletteOutput","text":"PaletteOutput"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},"<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"}],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/charts/common/palette.ts","lineNumber":119,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L119"},"initialIsOpen":false}],"interfaces":[{"id":"def-common.CustomPaletteArguments","type":"Interface","label":"CustomPaletteArguments","description":[],"children":[{"id":"def-common.CustomPaletteArguments.color","type":"Array","label":"color","description":[],"source":{"path":"src/plugins/charts/common/palette.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L14"},"signature":["string[] | undefined"]},{"id":"def-common.CustomPaletteArguments.gradient","type":"boolean","label":"gradient","description":[],"source":{"path":"src/plugins/charts/common/palette.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L15"}},{"id":"def-common.CustomPaletteArguments.reverse","type":"CompoundType","label":"reverse","description":[],"source":{"path":"src/plugins/charts/common/palette.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L16"},"signature":["boolean | undefined"]}],"source":{"path":"src/plugins/charts/common/palette.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L13"},"initialIsOpen":false},{"id":"def-common.CustomPaletteState","type":"Interface","label":"CustomPaletteState","description":[],"children":[{"id":"def-common.CustomPaletteState.colors","type":"Array","label":"colors","description":[],"source":{"path":"src/plugins/charts/common/palette.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L20"},"signature":["string[]"]},{"id":"def-common.CustomPaletteState.gradient","type":"boolean","label":"gradient","description":[],"source":{"path":"src/plugins/charts/common/palette.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L21"}}],"source":{"path":"src/plugins/charts/common/palette.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L19"},"initialIsOpen":false},{"id":"def-common.SystemPaletteArguments","type":"Interface","label":"SystemPaletteArguments","description":[],"children":[{"id":"def-common.SystemPaletteArguments.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/charts/common/palette.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L25"}}],"source":{"path":"src/plugins/charts/common/palette.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L24"},"initialIsOpen":false},{"id":"def-common.PaletteOutput","type":"Interface","label":"PaletteOutput","signature":[{"pluginId":"charts","scope":"common","docId":"kibChartsPluginApi","section":"def-common.PaletteOutput","text":"PaletteOutput"},""],"description":[],"children":[{"id":"def-common.PaletteOutput.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/charts/common/palette.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L29"},"signature":["\"palette\""]},{"id":"def-common.PaletteOutput.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/charts/common/palette.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L30"}},{"id":"def-common.PaletteOutput.params","type":"Uncategorized","label":"params","description":[],"source":{"path":"src/plugins/charts/common/palette.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L31"},"signature":["T | undefined"]}],"source":{"path":"src/plugins/charts/common/palette.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L28"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-common.COLOR_MAPPING_SETTING","type":"string","label":"COLOR_MAPPING_SETTING","description":[],"source":{"path":"src/plugins/charts/common/index.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/index.ts#L9"},"signature":["\"visualization:colorMapping\""],"initialIsOpen":false},{"id":"def-common.defaultCustomColors","type":"Array","label":"defaultCustomColors","description":[],"source":{"path":"src/plugins/charts/common/palette.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/palette.ts#L33"},"signature":["string[]"],"initialIsOpen":false},{"id":"def-common.paletteIds","type":"Array","label":"paletteIds","description":[],"source":{"path":"src/plugins/charts/common/constants.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/charts/common/constants.ts#L10"},"signature":["string[]"],"initialIsOpen":false}],"objects":[]}} \ No newline at end of file diff --git a/api_docs/charts.mdx b/api_docs/charts.mdx new file mode 100644 index 0000000000000..8b9983ce8697c --- /dev/null +++ b/api_docs/charts.mdx @@ -0,0 +1,34 @@ +--- +id: kibChartsPluginApi +slug: /kibana-dev-docs/chartsPluginApi +title: charts +image: https://source.unsplash.com/400x175/?github +summary: API docs for the charts plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'charts'] +--- + +import chartsObj from './charts.json'; + +## Client + +### Start + +### Objects + +### Functions + +### Interfaces + +### Enums + +### Consts, variables and types + +## Common + +### Functions + +### Interfaces + +### Consts, variables and types + diff --git a/api_docs/cloud.json b/api_docs/cloud.json new file mode 100644 index 0000000000000..48a079078e103 --- /dev/null +++ b/api_docs/cloud.json @@ -0,0 +1 @@ +{"id":"cloud","client":{"classes":[],"functions":[],"interfaces":[{"id":"def-public.CloudConfigType","type":"Interface","label":"CloudConfigType","description":[],"children":[{"id":"def-public.CloudConfigType.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/cloud/public/plugin.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L17"},"signature":["string | undefined"]},{"id":"def-public.CloudConfigType.resetPasswordUrl","type":"string","label":"resetPasswordUrl","description":[],"source":{"path":"x-pack/plugins/cloud/public/plugin.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L18"},"signature":["string | undefined"]},{"id":"def-public.CloudConfigType.deploymentUrl","type":"string","label":"deploymentUrl","description":[],"source":{"path":"x-pack/plugins/cloud/public/plugin.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L19"},"signature":["string | undefined"]},{"id":"def-public.CloudConfigType.accountUrl","type":"string","label":"accountUrl","description":[],"source":{"path":"x-pack/plugins/cloud/public/plugin.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L20"},"signature":["string | undefined"]}],"source":{"path":"x-pack/plugins/cloud/public/plugin.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L16"},"initialIsOpen":false}],"enums":[],"misc":[],"objects":[],"setup":{"id":"def-public.CloudSetup","type":"Interface","label":"CloudSetup","description":[],"children":[{"id":"def-public.CloudSetup.cloudId","type":"string","label":"cloudId","description":[],"source":{"path":"x-pack/plugins/cloud/public/plugin.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L32"},"signature":["string | undefined"]},{"id":"def-public.CloudSetup.cloudDeploymentUrl","type":"string","label":"cloudDeploymentUrl","description":[],"source":{"path":"x-pack/plugins/cloud/public/plugin.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L33"},"signature":["string | undefined"]},{"id":"def-public.CloudSetup.isCloudEnabled","type":"boolean","label":"isCloudEnabled","description":[],"source":{"path":"x-pack/plugins/cloud/public/plugin.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L34"}},{"id":"def-public.CloudSetup.resetPasswordUrl","type":"string","label":"resetPasswordUrl","description":[],"source":{"path":"x-pack/plugins/cloud/public/plugin.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L35"},"signature":["string | undefined"]},{"id":"def-public.CloudSetup.accountUrl","type":"string","label":"accountUrl","description":[],"source":{"path":"x-pack/plugins/cloud/public/plugin.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L36"},"signature":["string | undefined"]}],"source":{"path":"x-pack/plugins/cloud/public/plugin.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/public/plugin.ts#L31"},"lifecycle":"setup","initialIsOpen":true}},"server":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[],"setup":{"id":"def-server.CloudSetup","type":"Interface","label":"CloudSetup","description":[],"children":[{"id":"def-server.CloudSetup.cloudId","type":"string","label":"cloudId","description":[],"source":{"path":"x-pack/plugins/cloud/server/plugin.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/server/plugin.ts#L19"},"signature":["string | undefined"]},{"id":"def-server.CloudSetup.isCloudEnabled","type":"boolean","label":"isCloudEnabled","description":[],"source":{"path":"x-pack/plugins/cloud/server/plugin.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/server/plugin.ts#L20"}},{"id":"def-server.CloudSetup.apm","type":"Object","label":"apm","description":[],"source":{"path":"x-pack/plugins/cloud/server/plugin.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/server/plugin.ts#L21"},"signature":["{ url?: string | undefined; secretToken?: string | undefined; }"]}],"source":{"path":"x-pack/plugins/cloud/server/plugin.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/cloud/server/plugin.ts#L18"},"lifecycle":"setup","initialIsOpen":true}},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]}} \ No newline at end of file diff --git a/api_docs/cloud.mdx b/api_docs/cloud.mdx new file mode 100644 index 0000000000000..37fbabbf9fd54 --- /dev/null +++ b/api_docs/cloud.mdx @@ -0,0 +1,22 @@ +--- +id: kibCloudPluginApi +slug: /kibana-dev-docs/cloudPluginApi +title: cloud +image: https://source.unsplash.com/400x175/?github +summary: API docs for the cloud plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'cloud'] +--- + +import cloudObj from './cloud.json'; + +## Client + +### Setup + +### Interfaces + +## Server + +### Setup + diff --git a/api_docs/console.json b/api_docs/console.json new file mode 100644 index 0000000000000..90d70b288831b --- /dev/null +++ b/api_docs/console.json @@ -0,0 +1 @@ +{"id":"console","client":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"server":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[],"setup":{"id":"def-server.ConsoleSetup","type":"Type","label":"ConsoleSetup","description":[],"source":{"path":"src/plugins/console/server/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/console/server/types.ts#L13"},"signature":["{ addExtensionSpecFilePath: (path: string) => void; }"],"lifecycle":"setup","initialIsOpen":true},"start":{"id":"def-server.ConsoleStart","type":"Type","label":"ConsoleStart","description":[],"source":{"path":"src/plugins/console/server/types.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/console/server/types.ts#L18"},"signature":["{ addProcessorDefinition: (processor: any) => void; }"],"lifecycle":"start","initialIsOpen":true}},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]}} \ No newline at end of file diff --git a/api_docs/console.mdx b/api_docs/console.mdx new file mode 100644 index 0000000000000..42ee6e0a4fe1f --- /dev/null +++ b/api_docs/console.mdx @@ -0,0 +1,18 @@ +--- +id: kibConsolePluginApi +slug: /kibana-dev-docs/consolePluginApi +title: console +image: https://source.unsplash.com/400x175/?github +summary: API docs for the console plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'console'] +--- + +import consoleObj from './console.json'; + +## Server + +### Setup + +### Start + diff --git a/api_docs/core.json b/api_docs/core.json new file mode 100644 index 0000000000000..1c113724728fc --- /dev/null +++ b/api_docs/core.json @@ -0,0 +1 @@ +{"id":"core","client":{"classes":[{"id":"def-public.CoreSystem","type":"Class","label":"CoreSystem","description":["\nThe CoreSystem is the root of the new platform, and setups all parts\nof Kibana in the UI, including the LegacyPlatform which is managed\nby the LegacyPlatformService. As we migrate more things to the new\nplatform the CoreSystem will get many more Services.\n"],"children":[{"id":"def-public.CoreSystem.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"params","isRequired":true,"signature":["Params"],"description":[],"source":{"path":"src/core/public/core_system.ts","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/core_system.ts#L90"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/core_system.ts","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/core_system.ts#L90"}},{"id":"def-public.CoreSystem.setup","type":"Function","label":"setup","signature":["() => Promise<{ fatalErrors: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.FatalErrorsSetup","text":"FatalErrorsSetup"},"; } | undefined>"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/public/core_system.ts","lineNumber":122,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/core_system.ts#L122"}},{"id":"def-public.CoreSystem.start","type":"Function","label":"start","signature":["() => Promise<{ application: ",{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.InternalApplicationStart","text":"InternalApplicationStart"},"; } | undefined>"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/public/core_system.ts","lineNumber":164,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/core_system.ts#L164"}},{"id":"def-public.CoreSystem.stop","type":"Function","label":"stop","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/public/core_system.ts","lineNumber":245,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/core_system.ts#L245"}}],"source":{"path":"src/core/public/core_system.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/core_system.ts#L69"},"initialIsOpen":false},{"id":"def-public.ToastsApi","type":"Class","label":"ToastsApi","description":["\nMethods for adding and removing global toast messages."],"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastsApi","text":"ToastsApi"}," implements Pick<",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastsApi","text":"ToastsApi"},", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">"],"children":[{"id":"def-public.ToastsApi.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"id":"def-public.ToastsApi.Unnamed.deps","type":"Object","label":"deps","description":[],"children":[{"id":"def-public.ToastsApi.Unnamed.deps.uiSettings","type":"Object","label":"uiSettings","description":[],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L102"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.IUiSettingsClient","text":"IUiSettingsClient"}]}],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L102"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L102"}},{"id":"def-public.ToastsApi.start","type":"Function","label":"start","signature":["({ overlays, i18n }: { overlays: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.OverlayStart","text":"OverlayStart"},"; i18n: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.I18nStart","text":"I18nStart"},"; }) => void"],"description":[],"children":[{"id":"def-public.ToastsApi.start.{-overlays, i18n }","type":"Object","label":"{ overlays, i18n }","description":[],"children":[{"id":"def-public.ToastsApi.start.{-overlays, i18n }.overlays","type":"Object","label":"overlays","description":[],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":107,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L107"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.OverlayStart","text":"OverlayStart"}]},{"id":"def-public.ToastsApi.start.{-overlays, i18n }.i18n","type":"Object","label":"i18n","description":[],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":107,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L107"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.I18nStart","text":"I18nStart"}]}],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":107,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L107"}}],"tags":["internal"],"returnComment":[],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":107,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L107"}},{"id":"def-public.ToastsApi.get$","type":"Function","label":"get$","signature":["() => ","Observable","<",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Toast","text":"Toast"},"[]>"],"description":["Observable of the toast messages to show to the user."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":113,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L113"}},{"id":"def-public.ToastsApi.add","type":"Function","label":"add","signature":["(toastOrTitle: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastInput","text":"ToastInput"},") => ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Toast","text":"Toast"}],"description":["\nAdds a new toast to current array of toast.\n"],"children":[{"type":"CompoundType","label":"toastOrTitle","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastInput","text":"ToastInput"}],"description":["- a {@link ToastInput}"],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":123,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L123"}}],"tags":[],"returnComment":["a {@link Toast}"],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":123,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L123"}},{"id":"def-public.ToastsApi.remove","type":"Function","label":"remove","signature":["(toastOrId: string | ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Toast","text":"Toast"},") => void"],"description":["\nRemoves a toast from the current array of toasts if present."],"children":[{"type":"CompoundType","label":"toastOrId","isRequired":true,"signature":["string | ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Toast","text":"Toast"}],"description":["- a {@link Toast} returned by {@link ToastsApi.add} or its id"],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":139,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L139"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":139,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L139"}},{"id":"def-public.ToastsApi.addInfo","type":"Function","label":"addInfo","signature":["(toastOrTitle: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastInput","text":"ToastInput"},", options?: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastOptions","text":"ToastOptions"}," | undefined) => ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Toast","text":"Toast"}],"description":["\nAdds a new toast pre-configured with the info color and info icon.\n"],"children":[{"type":"CompoundType","label":"toastOrTitle","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastInput","text":"ToastInput"}],"description":["- a {@link ToastInput}"],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":155,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L155"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastOptions","text":"ToastOptions"}," | undefined"],"description":["- a {@link ToastOptions}"],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":155,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L155"}}],"tags":[],"returnComment":["a {@link Toast}"],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":155,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L155"}},{"id":"def-public.ToastsApi.addSuccess","type":"Function","label":"addSuccess","signature":["(toastOrTitle: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastInput","text":"ToastInput"},", options?: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastOptions","text":"ToastOptions"}," | undefined) => ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Toast","text":"Toast"}],"description":["\nAdds a new toast pre-configured with the success color and check icon.\n"],"children":[{"type":"CompoundType","label":"toastOrTitle","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastInput","text":"ToastInput"}],"description":["- a {@link ToastInput}"],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":171,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L171"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastOptions","text":"ToastOptions"}," | undefined"],"description":["- a {@link ToastOptions}"],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":171,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L171"}}],"tags":[],"returnComment":["a {@link Toast}"],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":171,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L171"}},{"id":"def-public.ToastsApi.addWarning","type":"Function","label":"addWarning","signature":["(toastOrTitle: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastInput","text":"ToastInput"},", options?: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastOptions","text":"ToastOptions"}," | undefined) => ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Toast","text":"Toast"}],"description":["\nAdds a new toast pre-configured with the warning color and help icon.\n"],"children":[{"type":"CompoundType","label":"toastOrTitle","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastInput","text":"ToastInput"}],"description":["- a {@link ToastInput}"],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":187,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L187"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastOptions","text":"ToastOptions"}," | undefined"],"description":["- a {@link ToastOptions}"],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":187,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L187"}}],"tags":[],"returnComment":["a {@link Toast}"],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":187,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L187"}},{"id":"def-public.ToastsApi.addDanger","type":"Function","label":"addDanger","signature":["(toastOrTitle: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastInput","text":"ToastInput"},", options?: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastOptions","text":"ToastOptions"}," | undefined) => ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Toast","text":"Toast"}],"description":["\nAdds a new toast pre-configured with the danger color and alert icon.\n"],"children":[{"type":"CompoundType","label":"toastOrTitle","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastInput","text":"ToastInput"}],"description":["- a {@link ToastInput}"],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":204,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L204"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastOptions","text":"ToastOptions"}," | undefined"],"description":["- a {@link ToastOptions}"],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":204,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L204"}}],"tags":[],"returnComment":["a {@link Toast}"],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":204,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L204"}},{"id":"def-public.ToastsApi.addError","type":"Function","label":"addError","signature":["(error: Error, options: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ErrorToastOptions","text":"ErrorToastOptions"},") => ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Toast","text":"Toast"}],"description":["\nAdds a new toast that displays an exception message with a button to open the full stacktrace in a modal.\n"],"children":[{"type":"Object","label":"error","isRequired":true,"signature":["Error"],"description":["- an `Error` instance."],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":221,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L221"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ErrorToastOptions","text":"ErrorToastOptions"}],"description":["- {@link ErrorToastOptions}"],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":221,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L221"}}],"tags":[],"returnComment":["a {@link Toast}"],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":221,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L221"}}],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L94"},"initialIsOpen":false}],"functions":[],"interfaces":[{"id":"def-public.PackageInfo","type":"Interface","label":"PackageInfo","signature":["PackageInfo"],"description":[],"children":[{"id":"def-public.PackageInfo.version","type":"string","label":"version","description":[],"source":{"path":"node_modules/@kbn/config/target/types.d.ts","lineNumber":5,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L5"}},{"id":"def-public.PackageInfo.branch","type":"string","label":"branch","description":[],"source":{"path":"node_modules/@kbn/config/target/types.d.ts","lineNumber":6,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L6"}},{"id":"def-public.PackageInfo.buildNum","type":"number","label":"buildNum","description":[],"source":{"path":"node_modules/@kbn/config/target/types.d.ts","lineNumber":7,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L7"}},{"id":"def-public.PackageInfo.buildSha","type":"string","label":"buildSha","description":[],"source":{"path":"node_modules/@kbn/config/target/types.d.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L8"}},{"id":"def-public.PackageInfo.dist","type":"boolean","label":"dist","description":[],"source":{"path":"node_modules/@kbn/config/target/types.d.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L9"}}],"source":{"path":"node_modules/@kbn/config/target/types.d.ts","lineNumber":4,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L4"},"initialIsOpen":false},{"id":"def-public.EnvironmentMode","type":"Interface","label":"EnvironmentMode","signature":["EnvironmentMode"],"description":[],"children":[{"id":"def-public.EnvironmentMode.name","type":"CompoundType","label":"name","description":[],"source":{"path":"node_modules/@kbn/config/target/types.d.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L15"},"signature":["\"production\" | \"development\""]},{"id":"def-public.EnvironmentMode.dev","type":"boolean","label":"dev","description":[],"source":{"path":"node_modules/@kbn/config/target/types.d.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L16"}},{"id":"def-public.EnvironmentMode.prod","type":"boolean","label":"prod","description":[],"source":{"path":"node_modules/@kbn/config/target/types.d.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L17"}}],"source":{"path":"node_modules/@kbn/config/target/types.d.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L14"},"initialIsOpen":false},{"id":"def-public.IExternalUrlPolicy","type":"Interface","label":"IExternalUrlPolicy","description":["\nA policy describing whether access to an external destination is allowed."],"children":[{"id":"def-public.IExternalUrlPolicy.allow","type":"boolean","label":"allow","description":["\nIndicates if this policy allows or denies access to the described destination."],"source":{"path":"src/core/server/external_url/external_url_config.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/external_url/external_url_config.ts#L33"}},{"id":"def-public.IExternalUrlPolicy.host","type":"string","label":"host","description":["\nOptional host describing the external destination.\nMay be combined with `protocol`.\n"],"source":{"path":"src/core/server/external_url/external_url_config.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/external_url/external_url_config.ts#L46"},"signature":["string | undefined"]},{"id":"def-public.IExternalUrlPolicy.protocol","type":"string","label":"protocol","description":["\nOptional protocol describing the external destination.\nMay be combined with `host`.\n"],"source":{"path":"src/core/server/external_url/external_url_config.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/external_url/external_url_config.ts#L59"},"signature":["string | undefined"]}],"source":{"path":"src/core/server/external_url/external_url_config.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/external_url/external_url_config.ts#L29"},"initialIsOpen":false},{"id":"def-public.CoreContext","type":"Interface","label":"CoreContext","description":[],"children":[{"id":"def-public.CoreContext.coreId","type":"Uncategorized","label":"coreId","description":[],"source":{"path":"src/core/public/core_system.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/core_system.ts#L42"},"signature":["symbol"]},{"id":"def-public.CoreContext.env","type":"Object","label":"env","description":[],"source":{"path":"src/core/public/core_system.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/core_system.ts#L43"},"signature":["{ mode: Readonly<","EnvironmentMode",">; packageInfo: Readonly<","PackageInfo",">; }"]}],"source":{"path":"src/core/public/core_system.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/core_system.ts#L41"},"initialIsOpen":false},{"id":"def-public.AppCategory","type":"Interface","label":"AppCategory","description":["\n\nA category definition for nav links to know where to sort them in the left hand nav"],"children":[{"id":"def-public.AppCategory.id","type":"string","label":"id","description":["\nUnique identifier for the categories"],"source":{"path":"src/core/types/app_category.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L19"}},{"id":"def-public.AppCategory.label","type":"string","label":"label","description":["\nLabel used for category name.\nAlso used as aria-label if one isn't set."],"source":{"path":"src/core/types/app_category.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L25"}},{"id":"def-public.AppCategory.ariaLabel","type":"string","label":"ariaLabel","description":["\nIf the visual label isn't appropriate for screen readers,\ncan override it here"],"source":{"path":"src/core/types/app_category.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L31"},"signature":["string | undefined"]},{"id":"def-public.AppCategory.order","type":"number","label":"order","description":["\nThe order that categories will be sorted in\nPrefer large steps between categories to allow for further editing\n(Default categories are in steps of 1000)"],"source":{"path":"src/core/types/app_category.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L38"},"signature":["number | undefined"]},{"id":"def-public.AppCategory.euiIconType","type":"string","label":"euiIconType","description":["\nDefine an icon to be used for the category\nIf the category is only 1 item, and no icon is defined, will default to the product icon\nDefaults to initials if no icon is defined"],"source":{"path":"src/core/types/app_category.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L45"},"signature":["string | undefined"]}],"source":{"path":"src/core/types/app_category.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L15"},"initialIsOpen":false},{"id":"def-public.UiSettingsParams","type":"Interface","label":"UiSettingsParams","signature":["UiSettingsParams",""],"description":["\nUiSettings parameters defined by the plugins."],"children":[{"id":"def-public.UiSettingsParams.name","type":"string","label":"name","description":["title in the UI"],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L45"},"signature":["string | undefined"]},{"id":"def-public.UiSettingsParams.value","type":"Uncategorized","label":"value","description":["default value to fall back to if a user doesn't provide any"],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L47"},"signature":["T | undefined"]},{"id":"def-public.UiSettingsParams.description","type":"string","label":"description","description":["description provided to a user in UI"],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L49"},"signature":["string | undefined"]},{"id":"def-public.UiSettingsParams.category","type":"Array","label":"category","description":["used to group the configured setting in the UI"],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L51"},"signature":["string[] | undefined"]},{"id":"def-public.UiSettingsParams.options","type":"Array","label":"options","description":["array of permitted values for this setting"],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L53"},"signature":["string[] | undefined"]},{"id":"def-public.UiSettingsParams.optionLabels","type":"Object","label":"optionLabels","description":["text labels for 'select' type UI element"],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L55"},"signature":["Record | undefined"]},{"id":"def-public.UiSettingsParams.requiresPageReload","type":"CompoundType","label":"requiresPageReload","description":["a flag indicating whether new value applying requires page reloading"],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L57"},"signature":["boolean | undefined"]},{"id":"def-public.UiSettingsParams.readonly","type":"CompoundType","label":"readonly","description":["a flag indicating that value cannot be changed"],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L59"},"signature":["boolean | undefined"]},{"id":"def-public.UiSettingsParams.sensitive","type":"CompoundType","label":"sensitive","description":["\na flag indicating that value might contain user sensitive data.\nused by telemetry to mask the value of the setting when sent."],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L64"},"signature":["boolean | undefined"]},{"id":"def-public.UiSettingsParams.type","type":"CompoundType","label":"type","description":["defines a type of UI element {@link UiSettingsType}"],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L66"},"signature":["\"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"json\" | \"image\" | \"select\" | \"array\" | \"markdown\" | undefined"]},{"id":"def-public.UiSettingsParams.deprecation","type":"Object","label":"deprecation","description":["optional deprecation information. Used to generate a deprecation warning."],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L68"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.DeprecationSettings","text":"DeprecationSettings"}," | undefined"]},{"id":"def-public.UiSettingsParams.order","type":"number","label":"order","description":["\nindex of the settings within its category (ascending order, smallest will be displayed first).\nUsed for ordering in the UI.\n"],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L75"},"signature":["number | undefined"]},{"id":"def-public.UiSettingsParams.validation","type":"CompoundType","label":"validation","description":[],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L81"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.ImageValidation","text":"ImageValidation"}," | ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.StringValidationRegex","text":"StringValidationRegex"}," | ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.StringValidationRegexString","text":"StringValidationRegexString"}," | undefined"]},{"id":"def-public.UiSettingsParams.schema","type":"Object","label":"schema","description":[],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L86"},"signature":["Type",""]},{"id":"def-public.UiSettingsParams.metric","type":"Object","label":"metric","description":["\nMetric to track once this property changes"],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L92"},"signature":["{ type: ","UiCounterMetricType","; name: string; } | undefined"]}],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L43"},"initialIsOpen":false},{"id":"def-public.UserProvidedValues","type":"Interface","label":"UserProvidedValues","signature":["UserProvidedValues",""],"description":["\nDescribes the values explicitly set by user."],"children":[{"id":"def-public.UserProvidedValues.userValue","type":"Uncategorized","label":"userValue","description":[],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":143,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L143"},"signature":["T | undefined"]},{"id":"def-public.UserProvidedValues.isOverridden","type":"CompoundType","label":"isOverridden","description":[],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":144,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L144"},"signature":["boolean | undefined"]}],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":142,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L142"},"initialIsOpen":false},{"id":"def-public.ImageValidation","type":"Interface","label":"ImageValidation","description":[],"children":[{"id":"def-public.ImageValidation.maxSize","type":"Object","label":"maxSize","description":[],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":132,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L132"},"signature":["{ length: number; description: string; }"]}],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L131"},"initialIsOpen":false},{"id":"def-public.StringValidationRegex","type":"Interface","label":"StringValidationRegex","description":["\nStringValidation with regex object"],"children":[{"id":"def-public.StringValidationRegex.regex","type":"Object","label":"regex","description":[],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L115"},"signature":["RegExp"]},{"id":"def-public.StringValidationRegex.message","type":"string","label":"message","description":[],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L116"}}],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":114,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L114"},"initialIsOpen":false},{"id":"def-public.StringValidationRegexString","type":"Interface","label":"StringValidationRegexString","description":["\nStringValidation as regex string"],"children":[{"id":"def-public.StringValidationRegexString.regexString","type":"string","label":"regexString","description":[],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":124,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L124"}},{"id":"def-public.StringValidationRegexString.message","type":"string","label":"message","description":[],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":125,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L125"}}],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":123,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L123"},"initialIsOpen":false},{"id":"def-public.SavedObject","type":"Interface","label":"SavedObject","signature":["SavedObject",""],"description":[],"children":[{"id":"def-public.SavedObject.id","type":"string","label":"id","description":["The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`"],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L71"}},{"id":"def-public.SavedObject.type","type":"string","label":"type","description":[" The type of Saved Object. Each plugin can define it's own custom Saved Object types."],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L73"}},{"id":"def-public.SavedObject.version","type":"string","label":"version","description":["An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control."],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L75"},"signature":["string | undefined"]},{"id":"def-public.SavedObject.updated_at","type":"string","label":"updated_at","description":["Timestamp of the last time this document had been updated."],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L77"},"signature":["string | undefined"]},{"id":"def-public.SavedObject.error","type":"Object","label":"error","description":[],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L78"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectError","text":"SavedObjectError"}," | undefined"]},{"id":"def-public.SavedObject.attributes","type":"Uncategorized","label":"attributes","description":["{@inheritdoc SavedObjectAttributes}"],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L80"},"signature":["T"]},{"id":"def-public.SavedObject.references","type":"Array","label":"references","description":["{@inheritdoc SavedObjectReference}"],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L82"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[]"]},{"id":"def-public.SavedObject.migrationVersion","type":"Object","label":"migrationVersion","description":["{@inheritdoc SavedObjectsMigrationVersion}"],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L84"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectsMigrationVersion","text":"SavedObjectsMigrationVersion"}," | undefined"]},{"id":"def-public.SavedObject.coreMigrationVersion","type":"string","label":"coreMigrationVersion","description":["A semver value that is used when upgrading objects between Kibana versions."],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L86"},"signature":["string | undefined"]},{"id":"def-public.SavedObject.namespaces","type":"Array","label":"namespaces","description":["Namespace(s) that this saved object exists in. This attribute is only used for multi-namespace saved object types."],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L88"},"signature":["string[] | undefined"]},{"id":"def-public.SavedObject.originId","type":"string","label":"originId","description":["\nThe ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration\nfrom a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import\nto ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given\nspace."],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L95"},"signature":["string | undefined"]}],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L69"},"initialIsOpen":false},{"id":"def-public.SavedObjectAttributes","type":"Interface","label":"SavedObjectAttributes","description":["\nThe data for a Saved Object is stored as an object in the `attributes`\nproperty.\n"],"children":[{"id":"def-public.SavedObjectAttributes.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L36"},"signature":["any"]}],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L35"},"initialIsOpen":false},{"id":"def-public.SavedObjectError","type":"Interface","label":"SavedObjectError","description":[],"children":[{"id":"def-public.SavedObjectError.error","type":"string","label":"error","description":[],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L99"}},{"id":"def-public.SavedObjectError.message","type":"string","label":"message","description":[],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":100,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L100"}},{"id":"def-public.SavedObjectError.statusCode","type":"number","label":"statusCode","description":[],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L101"}},{"id":"def-public.SavedObjectError.metadata","type":"Object","label":"metadata","description":[],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L102"},"signature":["Record | undefined"]}],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L98"},"initialIsOpen":false},{"id":"def-public.SavedObjectReference","type":"Interface","label":"SavedObjectReference","description":["\nA reference to another saved object.\n"],"children":[{"id":"def-public.SavedObjectReference.name","type":"string","label":"name","description":[],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L45"}},{"id":"def-public.SavedObjectReference.type","type":"string","label":"type","description":[],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L46"}},{"id":"def-public.SavedObjectReference.id","type":"string","label":"id","description":[],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L47"}}],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L44"},"initialIsOpen":false},{"id":"def-public.SavedObjectsBaseOptions","type":"Interface","label":"SavedObjectsBaseOptions","description":["\n"],"children":[{"id":"def-public.SavedObjectsBaseOptions.namespace","type":"string","label":"namespace","description":["Specify the namespace for this operation"],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":141,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L141"},"signature":["string | undefined"]}],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":139,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L139"},"initialIsOpen":false},{"id":"def-public.SavedObjectsFindOptions","type":"Interface","label":"SavedObjectsFindOptions","description":["\n"],"children":[{"id":"def-public.SavedObjectsFindOptions.type","type":"CompoundType","label":"type","description":[],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L78"},"signature":["string | string[]"]},{"id":"def-public.SavedObjectsFindOptions.page","type":"number","label":"page","description":[],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L79"},"signature":["number | undefined"]},{"id":"def-public.SavedObjectsFindOptions.perPage","type":"number","label":"perPage","description":[],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L80"},"signature":["number | undefined"]},{"id":"def-public.SavedObjectsFindOptions.sortField","type":"string","label":"sortField","description":[],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L81"},"signature":["string | undefined"]},{"id":"def-public.SavedObjectsFindOptions.sortOrder","type":"string","label":"sortOrder","description":[],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L82"},"signature":["string | undefined"]},{"id":"def-public.SavedObjectsFindOptions.fields","type":"Array","label":"fields","description":["\nAn array of fields to include in the results"],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L88"},"signature":["string[] | undefined"]},{"id":"def-public.SavedObjectsFindOptions.search","type":"string","label":"search","description":["Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information"],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L90"},"signature":["string | undefined"]},{"id":"def-public.SavedObjectsFindOptions.searchFields","type":"Array","label":"searchFields","description":["The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information"],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L92"},"signature":["string[] | undefined"]},{"id":"def-public.SavedObjectsFindOptions.searchAfter","type":"Array","label":"searchAfter","description":["\nUse the sort values from the previous page to retrieve the next page of results."],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L96"},"signature":["unknown[] | undefined"]},{"id":"def-public.SavedObjectsFindOptions.rootSearchFields","type":"Array","label":"rootSearchFields","description":["\nThe fields to perform the parsed query against. Unlike the `searchFields` argument, these are expected to be root fields and will not\nbe modified. If used in conjunction with `searchFields`, both are concatenated together."],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L101"},"signature":["string[] | undefined"]},{"id":"def-public.SavedObjectsFindOptions.hasReference","type":"CompoundType","label":"hasReference","description":["\nSearch for documents having a reference to the specified objects.\nUse `hasReferenceOperator` to specify the operator to use when searching for multiple references."],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":107,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L107"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsFindOptionsReference","text":"SavedObjectsFindOptionsReference"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsFindOptionsReference","text":"SavedObjectsFindOptionsReference"},"[] | undefined"]},{"id":"def-public.SavedObjectsFindOptions.hasReferenceOperator","type":"CompoundType","label":"hasReferenceOperator","description":["\nThe operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR`"],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":111,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L111"},"signature":["\"AND\" | \"OR\" | undefined"]},{"id":"def-public.SavedObjectsFindOptions.defaultSearchOperator","type":"CompoundType","label":"defaultSearchOperator","description":["\nThe search operator to use with the provided filter. Defaults to `OR`"],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L116"},"signature":["\"AND\" | \"OR\" | undefined"]},{"id":"def-public.SavedObjectsFindOptions.filter","type":"Any","label":"filter","description":[],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":117,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L117"},"signature":["any"]},{"id":"def-public.SavedObjectsFindOptions.namespaces","type":"Array","label":"namespaces","description":[],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":118,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L118"},"signature":["string[] | undefined"]},{"id":"def-public.SavedObjectsFindOptions.typeToNamespacesMap","type":"Object","label":"typeToNamespacesMap","description":["\nThis map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved\nobject client wrapper.\nIf this is defined, it supersedes the `type` and `namespaces` fields when building the Elasticsearch query.\nAny types that are not included in this map will be excluded entirely.\nIf a type is included but its value is undefined, the operation will search for that type in the Default namespace."],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":126,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L126"},"signature":["Map | undefined"]},{"id":"def-public.SavedObjectsFindOptions.preference","type":"string","label":"preference","description":["An optional ES preference value to be used for the query"],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":128,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L128"},"signature":["string | undefined"]},{"id":"def-public.SavedObjectsFindOptions.pit","type":"Object","label":"pit","description":["\nSearch against a specific Point In Time (PIT) that you've opened with {@link SavedObjectsClient.openPointInTimeForType}."],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":132,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L132"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsPitParams","text":"SavedObjectsPitParams"}," | undefined"]}],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L77"},"initialIsOpen":false},{"id":"def-public.SavedObjectsFindOptionsReference","type":"Interface","label":"SavedObjectsFindOptionsReference","description":[],"children":[{"id":"def-public.SavedObjectsFindOptionsReference.type","type":"string","label":"type","description":[],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L61"}},{"id":"def-public.SavedObjectsFindOptionsReference.id","type":"string","label":"id","description":[],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L62"}}],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L60"},"initialIsOpen":false},{"id":"def-public.SavedObjectsMigrationVersion","type":"Interface","label":"SavedObjectsMigrationVersion","description":["\nInformation about the migrations that have been applied to this SavedObject.\nWhen Kibana starts up, KibanaMigrator detects outdated documents and\nmigrates them based on this value. For each migration that has been applied,\nthe plugin's name is used as a key and the latest migration version as the\nvalue.\n"],"children":[{"id":"def-public.SavedObjectsMigrationVersion.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L66"},"signature":["any"]}],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L65"},"initialIsOpen":false},{"id":"def-public.SavedObjectsImportResponse","type":"Interface","label":"SavedObjectsImportResponse","description":["\nThe response describing the result of an import."],"children":[{"id":"def-public.SavedObjectsImportResponse.success","type":"boolean","label":"success","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":142,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L142"}},{"id":"def-public.SavedObjectsImportResponse.successCount","type":"number","label":"successCount","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":143,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L143"}},{"id":"def-public.SavedObjectsImportResponse.successResults","type":"Array","label":"successResults","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":144,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L144"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportSuccess","text":"SavedObjectsImportSuccess"},"[] | undefined"]},{"id":"def-public.SavedObjectsImportResponse.warnings","type":"Array","label":"warnings","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":145,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L145"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportWarning","text":"SavedObjectsImportWarning"},"[]"]},{"id":"def-public.SavedObjectsImportResponse.errors","type":"Array","label":"errors","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":146,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L146"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportFailure","text":"SavedObjectsImportFailure"},"[] | undefined"]}],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":141,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L141"},"initialIsOpen":false},{"id":"def-public.SavedObjectsImportSuccess","type":"Interface","label":"SavedObjectsImportSuccess","description":["\nRepresents a successful import."],"children":[{"id":"def-public.SavedObjectsImportSuccess.id","type":"string","label":"id","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":114,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L114"}},{"id":"def-public.SavedObjectsImportSuccess.type","type":"string","label":"type","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L115"}},{"id":"def-public.SavedObjectsImportSuccess.destinationId","type":"string","label":"destinationId","description":["\nIf `destinationId` is specified, the new object has a new ID that is different from the import ID."],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":119,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L119"},"signature":["string | undefined"]},{"id":"def-public.SavedObjectsImportSuccess.createNewCopy","type":"CompoundType","label":"createNewCopy","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":126,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L126"},"signature":["boolean | undefined"]},{"id":"def-public.SavedObjectsImportSuccess.meta","type":"Object","label":"meta","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":127,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L127"},"signature":["{ title?: string | undefined; icon?: string | undefined; }"]},{"id":"def-public.SavedObjectsImportSuccess.overwrite","type":"CompoundType","label":"overwrite","description":["\nIf `overwrite` is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution)."],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":134,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L134"},"signature":["boolean | undefined"]}],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":113,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L113"},"initialIsOpen":false},{"id":"def-public.SavedObjectsImportConflictError","type":"Interface","label":"SavedObjectsImportConflictError","description":["\nRepresents a failure to import due to a conflict."],"children":[{"id":"def-public.SavedObjectsImportConflictError.type","type":"string","label":"type","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L45"},"signature":["\"conflict\""]},{"id":"def-public.SavedObjectsImportConflictError.destinationId","type":"string","label":"destinationId","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L46"},"signature":["string | undefined"]}],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L44"},"initialIsOpen":false},{"id":"def-public.SavedObjectsImportAmbiguousConflictError","type":"Interface","label":"SavedObjectsImportAmbiguousConflictError","description":["\nRepresents a failure to import due to a conflict, which can be resolved in different ways with an overwrite."],"children":[{"id":"def-public.SavedObjectsImportAmbiguousConflictError.type","type":"string","label":"type","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L54"},"signature":["\"ambiguous_conflict\""]},{"id":"def-public.SavedObjectsImportAmbiguousConflictError.destinations","type":"Array","label":"destinations","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L55"},"signature":["{ id: string; title?: string | undefined; updatedAt?: string | undefined; }[]"]}],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L53"},"initialIsOpen":false},{"id":"def-public.SavedObjectsImportUnsupportedTypeError","type":"Interface","label":"SavedObjectsImportUnsupportedTypeError","description":["\nRepresents a failure to import due to having an unsupported saved object type."],"children":[{"id":"def-public.SavedObjectsImportUnsupportedTypeError.type","type":"string","label":"type","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L63"},"signature":["\"unsupported_type\""]}],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L62"},"initialIsOpen":false},{"id":"def-public.SavedObjectsImportMissingReferencesError","type":"Interface","label":"SavedObjectsImportMissingReferencesError","description":["\nRepresents a failure to import due to missing references."],"children":[{"id":"def-public.SavedObjectsImportMissingReferencesError.type","type":"string","label":"type","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L81"},"signature":["\"missing_references\""]},{"id":"def-public.SavedObjectsImportMissingReferencesError.references","type":"Array","label":"references","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L82"},"signature":["{ type: string; id: string; }[]"]}],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L80"},"initialIsOpen":false},{"id":"def-public.SavedObjectsImportUnknownError","type":"Interface","label":"SavedObjectsImportUnknownError","description":["\nRepresents a failure to import due to an unknown reason."],"children":[{"id":"def-public.SavedObjectsImportUnknownError.type","type":"string","label":"type","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L71"},"signature":["\"unknown\""]},{"id":"def-public.SavedObjectsImportUnknownError.message","type":"string","label":"message","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L72"}},{"id":"def-public.SavedObjectsImportUnknownError.statusCode","type":"number","label":"statusCode","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L73"}}],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L70"},"initialIsOpen":false},{"id":"def-public.SavedObjectsImportFailure","type":"Interface","label":"SavedObjectsImportFailure","description":["\nRepresents a failure to import."],"children":[{"id":"def-public.SavedObjectsImportFailure.id","type":"string","label":"id","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L90"}},{"id":"def-public.SavedObjectsImportFailure.type","type":"string","label":"type","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":91,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L91"}},{"id":"def-public.SavedObjectsImportFailure.title","type":"string","label":"title","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L95"},"signature":["string | undefined"]},{"id":"def-public.SavedObjectsImportFailure.meta","type":"Object","label":"meta","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L96"},"signature":["{ title?: string | undefined; icon?: string | undefined; }"]},{"id":"def-public.SavedObjectsImportFailure.overwrite","type":"CompoundType","label":"overwrite","description":["\nIf `overwrite` is specified, an attempt was made to overwrite an existing object."],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":100,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L100"},"signature":["boolean | undefined"]},{"id":"def-public.SavedObjectsImportFailure.error","type":"CompoundType","label":"error","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L101"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportConflictError","text":"SavedObjectsImportConflictError"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportAmbiguousConflictError","text":"SavedObjectsImportAmbiguousConflictError"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportUnsupportedTypeError","text":"SavedObjectsImportUnsupportedTypeError"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportMissingReferencesError","text":"SavedObjectsImportMissingReferencesError"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportUnknownError","text":"SavedObjectsImportUnknownError"}]}],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L89"},"initialIsOpen":false},{"id":"def-public.SavedObjectsImportRetry","type":"Interface","label":"SavedObjectsImportRetry","description":["\nDescribes a retry operation for importing a saved object."],"children":[{"id":"def-public.SavedObjectsImportRetry.type","type":"string","label":"type","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L17"}},{"id":"def-public.SavedObjectsImportRetry.id","type":"string","label":"id","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L18"}},{"id":"def-public.SavedObjectsImportRetry.overwrite","type":"boolean","label":"overwrite","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L19"}},{"id":"def-public.SavedObjectsImportRetry.destinationId","type":"string","label":"destinationId","description":["\nThe object ID that will be created or overwritten. If not specified, the `id` field will be used."],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L23"},"signature":["string | undefined"]},{"id":"def-public.SavedObjectsImportRetry.replaceReferences","type":"Array","label":"replaceReferences","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L24"},"signature":["{ type: string; from: string; to: string; }[]"]},{"id":"def-public.SavedObjectsImportRetry.createNewCopy","type":"CompoundType","label":"createNewCopy","description":["\nIf `createNewCopy` is specified, the new object has a new (undefined) origin ID. This is only needed for the case where\n`createNewCopies` mode is disabled and ambiguous source conflicts are detected."],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L33"},"signature":["boolean | undefined"]},{"id":"def-public.SavedObjectsImportRetry.ignoreMissingReferences","type":"CompoundType","label":"ignoreMissingReferences","description":["\nIf `ignoreMissingReferences` is specified, reference validation will be skipped for this object."],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L37"},"signature":["boolean | undefined"]}],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L16"},"initialIsOpen":false},{"id":"def-public.SavedObjectsImportSimpleWarning","type":"Interface","label":"SavedObjectsImportSimpleWarning","description":["\nA simple informative warning that will be displayed to the user.\n"],"children":[{"id":"def-public.SavedObjectsImportSimpleWarning.type","type":"string","label":"type","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":187,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L187"},"signature":["\"simple\""]},{"id":"def-public.SavedObjectsImportSimpleWarning.message","type":"string","label":"message","description":["The translated message to display to the user"],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":189,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L189"}}],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":186,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L186"},"initialIsOpen":false},{"id":"def-public.SavedObjectsImportActionRequiredWarning","type":"Interface","label":"SavedObjectsImportActionRequiredWarning","description":["\nA warning meant to notify that a specific user action is required to finalize the import\nof some type of object.\n"],"children":[{"id":"def-public.SavedObjectsImportActionRequiredWarning.type","type":"string","label":"type","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":201,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L201"},"signature":["\"action_required\""]},{"id":"def-public.SavedObjectsImportActionRequiredWarning.message","type":"string","label":"message","description":["The translated message to display to the user."],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":203,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L203"}},{"id":"def-public.SavedObjectsImportActionRequiredWarning.actionPath","type":"string","label":"actionPath","description":["The path (without the basePath) that the user should be redirect to to address this warning."],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":205,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L205"}},{"id":"def-public.SavedObjectsImportActionRequiredWarning.buttonLabel","type":"string","label":"buttonLabel","description":["An optional label to use for the link button. If unspecified, a default label will be used."],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":207,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L207"},"signature":["string | undefined"]}],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":200,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L200"},"initialIsOpen":false},{"id":"def-public.OverlayStart","type":"Interface","label":"OverlayStart","description":[],"children":[{"id":"def-public.OverlayStart.banners","type":"Object","label":"banners","description":["{@link OverlayBannersStart}"],"source":{"path":"src/core/public/overlays/overlay_service.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/overlay_service.ts#L50"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.OverlayBannersStart","text":"OverlayBannersStart"}]},{"id":"def-public.OverlayStart.openFlyout","type":"Function","label":"openFlyout","description":["{@link OverlayFlyoutStart#open}"],"source":{"path":"src/core/public/overlays/overlay_service.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/overlay_service.ts#L52"},"signature":["(mount: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.MountPoint","text":"MountPoint"},", options?: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.OverlayFlyoutOpenOptions","text":"OverlayFlyoutOpenOptions"}," | undefined) => ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.OverlayRef","text":"OverlayRef"}]},{"id":"def-public.OverlayStart.openModal","type":"Function","label":"openModal","description":["{@link OverlayModalStart#open}"],"source":{"path":"src/core/public/overlays/overlay_service.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/overlay_service.ts#L54"},"signature":["(mount: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.MountPoint","text":"MountPoint"},", options?: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.OverlayModalOpenOptions","text":"OverlayModalOpenOptions"}," | undefined) => ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.OverlayRef","text":"OverlayRef"}]},{"id":"def-public.OverlayStart.openConfirm","type":"Function","label":"openConfirm","description":["{@link OverlayModalStart#openConfirm}"],"source":{"path":"src/core/public/overlays/overlay_service.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/overlay_service.ts#L56"},"signature":["(message: string | ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.MountPoint","text":"MountPoint"},", options?: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.OverlayModalConfirmOptions","text":"OverlayModalConfirmOptions"}," | undefined) => Promise"]}],"source":{"path":"src/core/public/overlays/overlay_service.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/overlay_service.ts#L48"},"initialIsOpen":false},{"id":"def-public.OverlayBannersStart","type":"Interface","label":"OverlayBannersStart","description":[],"children":[{"id":"def-public.OverlayBannersStart.add","type":"Function","label":"add","signature":["(mount: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.MountPoint","text":"MountPoint"},", priority?: number | undefined) => string"],"description":["\nAdd a new banner\n"],"children":[{"type":"Function","label":"mount","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.MountPoint","text":"MountPoint"},""],"description":[],"source":{"path":"src/core/public/overlays/banners/banners_service.tsx","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/banners/banners_service.tsx#L30"}},{"type":"number","label":"priority","isRequired":false,"signature":["number | undefined"],"description":["optional priority order to display this banner. Higher priority values are shown first."],"source":{"path":"src/core/public/overlays/banners/banners_service.tsx","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/banners/banners_service.tsx#L30"}}],"tags":["link"],"returnComment":["a unique identifier for the given banner to be used with {@link OverlayBannersStart.remove} and\n{@link OverlayBannersStart.replace}"],"source":{"path":"src/core/public/overlays/banners/banners_service.tsx","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/banners/banners_service.tsx#L30"}},{"id":"def-public.OverlayBannersStart.remove","type":"Function","label":"remove","signature":["(id: string) => boolean"],"description":["\nRemove a banner\n"],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":["the unique identifier for the banner returned by {@link OverlayBannersStart.add}"],"source":{"path":"src/core/public/overlays/banners/banners_service.tsx","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/banners/banners_service.tsx#L38"}}],"tags":[],"returnComment":["if the banner was found or not"],"source":{"path":"src/core/public/overlays/banners/banners_service.tsx","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/banners/banners_service.tsx#L38"}},{"id":"def-public.OverlayBannersStart.replace","type":"Function","label":"replace","signature":["(id: string | undefined, mount: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.MountPoint","text":"MountPoint"},", priority?: number | undefined) => string"],"description":["\nReplace a banner in place\n"],"children":[{"type":"string","label":"id","isRequired":false,"signature":["string | undefined"],"description":["the unique identifier for the banner returned by {@link OverlayBannersStart.add}"],"source":{"path":"src/core/public/overlays/banners/banners_service.tsx","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/banners/banners_service.tsx#L49"}},{"type":"Function","label":"mount","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.MountPoint","text":"MountPoint"},""],"description":[],"source":{"path":"src/core/public/overlays/banners/banners_service.tsx","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/banners/banners_service.tsx#L49"}},{"type":"number","label":"priority","isRequired":false,"signature":["number | undefined"],"description":["optional priority order to display this banner. Higher priority values are shown first."],"source":{"path":"src/core/public/overlays/banners/banners_service.tsx","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/banners/banners_service.tsx#L49"}}],"tags":["link"],"returnComment":["a new identifier for the given banner to be used with {@link OverlayBannersStart.remove} and\n{@link OverlayBannersStart.replace}"],"source":{"path":"src/core/public/overlays/banners/banners_service.tsx","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/banners/banners_service.tsx#L49"}},{"id":"def-public.OverlayBannersStart.get$","type":"Function","label":"get$","signature":["() => ","Observable","<",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.OverlayBanner","text":"OverlayBanner"},"[]>"],"description":[],"children":[],"tags":["internal"],"returnComment":[],"source":{"path":"src/core/public/overlays/banners/banners_service.tsx","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/banners/banners_service.tsx#L52"}},{"id":"def-public.OverlayBannersStart.getComponent","type":"Function","label":"getComponent","signature":["() => JSX.Element"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/public/overlays/banners/banners_service.tsx","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/banners/banners_service.tsx#L53"}}],"source":{"path":"src/core/public/overlays/banners/banners_service.tsx","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/banners/banners_service.tsx#L21"},"initialIsOpen":false},{"id":"def-public.OverlayRef","type":"Interface","label":"OverlayRef","description":["\nReturned by {@link OverlayStart} methods for closing a mounted overlay."],"children":[{"id":"def-public.OverlayRef.onClose","type":"Object","label":"onClose","description":["\nA Promise that will resolve once this overlay is closed.\n\nOverlays can close from user interaction, calling `close()` on the overlay\nreference or another overlay replacing yours via `openModal` or `openFlyout`."],"source":{"path":"src/core/public/overlays/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/types.ts#L20"},"signature":["Promise"]},{"id":"def-public.OverlayRef.close","type":"Function","label":"close","signature":["() => Promise"],"description":["\nCloses the referenced overlay if it's still open which in turn will\nresolve the `onClose` Promise. If the overlay had already been\nclosed this method does nothing."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/public/overlays/types.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/types.ts#L27"}}],"source":{"path":"src/core/public/overlays/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/types.ts#L13"},"initialIsOpen":false},{"id":"def-public.OverlayFlyoutStart","type":"Interface","label":"OverlayFlyoutStart","description":["\nAPIs to open and manage fly-out dialogs.\n"],"children":[{"id":"def-public.OverlayFlyoutStart.open","type":"Function","label":"open","signature":["(mount: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.MountPoint","text":"MountPoint"},", options?: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.OverlayFlyoutOpenOptions","text":"OverlayFlyoutOpenOptions"}," | undefined) => ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.OverlayRef","text":"OverlayRef"}],"description":["\nOpens a flyout panel with the given mount point inside. You can use\n`close()` on the returned FlyoutRef to close the flyout.\n"],"children":[{"type":"Function","label":"mount","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.MountPoint","text":"MountPoint"},""],"description":[],"source":{"path":"src/core/public/overlays/flyout/flyout_service.tsx","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/flyout/flyout_service.tsx#L74"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.OverlayFlyoutOpenOptions","text":"OverlayFlyoutOpenOptions"}," | undefined"],"description":[],"source":{"path":"src/core/public/overlays/flyout/flyout_service.tsx","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/flyout/flyout_service.tsx#L74"}}],"tags":["link","link","return","link"],"returnComment":[],"source":{"path":"src/core/public/overlays/flyout/flyout_service.tsx","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/flyout/flyout_service.tsx#L74"}}],"source":{"path":"src/core/public/overlays/flyout/flyout_service.tsx","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/flyout/flyout_service.tsx#L65"},"initialIsOpen":false},{"id":"def-public.OverlayFlyoutOpenOptions","type":"Interface","label":"OverlayFlyoutOpenOptions","description":[],"children":[{"id":"def-public.OverlayFlyoutOpenOptions.className","type":"string","label":"className","description":[],"source":{"path":"src/core/public/overlays/flyout/flyout_service.tsx","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/flyout/flyout_service.tsx#L81"},"signature":["string | undefined"]},{"id":"def-public.OverlayFlyoutOpenOptions.closeButtonAriaLabel","type":"string","label":"closeButtonAriaLabel","description":[],"source":{"path":"src/core/public/overlays/flyout/flyout_service.tsx","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/flyout/flyout_service.tsx#L82"},"signature":["string | undefined"]},{"id":"def-public.OverlayFlyoutOpenOptions.ownFocus","type":"CompoundType","label":"ownFocus","description":[],"source":{"path":"src/core/public/overlays/flyout/flyout_service.tsx","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/flyout/flyout_service.tsx#L83"},"signature":["boolean | undefined"]},{"id":"def-public.OverlayFlyoutOpenOptions.'data-test-subj'","type":"string","label":"'data-test-subj'","description":[],"source":{"path":"src/core/public/overlays/flyout/flyout_service.tsx","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/flyout/flyout_service.tsx#L84"},"signature":["string | undefined"]},{"id":"def-public.OverlayFlyoutOpenOptions.size","type":"CompoundType","label":"size","description":[],"source":{"path":"src/core/public/overlays/flyout/flyout_service.tsx","lineNumber":85,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/flyout/flyout_service.tsx#L85"},"signature":["\"m\" | \"s\" | \"l\" | undefined"]},{"id":"def-public.OverlayFlyoutOpenOptions.maxWidth","type":"CompoundType","label":"maxWidth","description":[],"source":{"path":"src/core/public/overlays/flyout/flyout_service.tsx","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/flyout/flyout_service.tsx#L86"},"signature":["string | number | boolean | undefined"]}],"source":{"path":"src/core/public/overlays/flyout/flyout_service.tsx","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/flyout/flyout_service.tsx#L80"},"initialIsOpen":false},{"id":"def-public.OverlayModalOpenOptions","type":"Interface","label":"OverlayModalOpenOptions","description":[],"children":[{"id":"def-public.OverlayModalOpenOptions.className","type":"string","label":"className","description":[],"source":{"path":"src/core/public/overlays/modal/modal_service.tsx","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L101"},"signature":["string | undefined"]},{"id":"def-public.OverlayModalOpenOptions.closeButtonAriaLabel","type":"string","label":"closeButtonAriaLabel","description":[],"source":{"path":"src/core/public/overlays/modal/modal_service.tsx","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L102"},"signature":["string | undefined"]},{"id":"def-public.OverlayModalOpenOptions.'data-test-subj'","type":"string","label":"'data-test-subj'","description":[],"source":{"path":"src/core/public/overlays/modal/modal_service.tsx","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L103"},"signature":["string | undefined"]},{"id":"def-public.OverlayModalOpenOptions.maxWidth","type":"CompoundType","label":"maxWidth","description":[],"source":{"path":"src/core/public/overlays/modal/modal_service.tsx","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L104"},"signature":["string | number | boolean | undefined"]}],"source":{"path":"src/core/public/overlays/modal/modal_service.tsx","lineNumber":100,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L100"},"initialIsOpen":false},{"id":"def-public.OverlayModalConfirmOptions","type":"Interface","label":"OverlayModalConfirmOptions","description":[],"children":[{"id":"def-public.OverlayModalConfirmOptions.title","type":"string","label":"title","description":[],"source":{"path":"src/core/public/overlays/modal/modal_service.tsx","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L54"},"signature":["string | undefined"]},{"id":"def-public.OverlayModalConfirmOptions.cancelButtonText","type":"string","label":"cancelButtonText","description":[],"source":{"path":"src/core/public/overlays/modal/modal_service.tsx","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L55"},"signature":["string | undefined"]},{"id":"def-public.OverlayModalConfirmOptions.confirmButtonText","type":"string","label":"confirmButtonText","description":[],"source":{"path":"src/core/public/overlays/modal/modal_service.tsx","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L56"},"signature":["string | undefined"]},{"id":"def-public.OverlayModalConfirmOptions.className","type":"string","label":"className","description":[],"source":{"path":"src/core/public/overlays/modal/modal_service.tsx","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L57"},"signature":["string | undefined"]},{"id":"def-public.OverlayModalConfirmOptions.closeButtonAriaLabel","type":"string","label":"closeButtonAriaLabel","description":[],"source":{"path":"src/core/public/overlays/modal/modal_service.tsx","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L58"},"signature":["string | undefined"]},{"id":"def-public.OverlayModalConfirmOptions.'data-test-subj'","type":"string","label":"'data-test-subj'","description":[],"source":{"path":"src/core/public/overlays/modal/modal_service.tsx","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L59"},"signature":["string | undefined"]},{"id":"def-public.OverlayModalConfirmOptions.defaultFocusedButton","type":"CompoundType","label":"defaultFocusedButton","description":[],"source":{"path":"src/core/public/overlays/modal/modal_service.tsx","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L60"},"signature":["\"cancel\" | \"confirm\" | undefined"]},{"id":"def-public.OverlayModalConfirmOptions.buttonColor","type":"CompoundType","label":"buttonColor","description":[],"source":{"path":"src/core/public/overlays/modal/modal_service.tsx","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L61"},"signature":["\"warning\" | \"text\" | \"primary\" | \"danger\" | \"secondary\" | \"ghost\" | undefined"]},{"id":"def-public.OverlayModalConfirmOptions.maxWidth","type":"CompoundType","label":"maxWidth","description":["\nSets the max-width of the modal.\nSet to `true` to use the default (`euiBreakpoints 'm'`),\nset to `false` to not restrict the width,\nset to a number for a custom width in px,\nset to a string for a custom width in custom measurement."],"source":{"path":"src/core/public/overlays/modal/modal_service.tsx","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L69"},"signature":["string | number | boolean | undefined"]}],"source":{"path":"src/core/public/overlays/modal/modal_service.tsx","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L53"},"initialIsOpen":false},{"id":"def-public.OverlayModalStart","type":"Interface","label":"OverlayModalStart","description":["\nAPIs to open and manage modal dialogs.\n"],"children":[{"id":"def-public.OverlayModalStart.open","type":"Function","label":"open","signature":["(mount: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.MountPoint","text":"MountPoint"},", options?: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.OverlayModalOpenOptions","text":"OverlayModalOpenOptions"}," | undefined) => ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.OverlayRef","text":"OverlayRef"}],"description":["\nOpens a modal panel with the given mount point inside. You can use\n`close()` on the returned OverlayRef to close the modal.\n"],"children":[{"type":"Function","label":"mount","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.MountPoint","text":"MountPoint"},""],"description":[],"source":{"path":"src/core/public/overlays/modal/modal_service.tsx","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L86"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.OverlayModalOpenOptions","text":"OverlayModalOpenOptions"}," | undefined"],"description":[],"source":{"path":"src/core/public/overlays/modal/modal_service.tsx","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L86"}}],"tags":["link","link","return","link"],"returnComment":[],"source":{"path":"src/core/public/overlays/modal/modal_service.tsx","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L86"}},{"id":"def-public.OverlayModalStart.openConfirm","type":"Function","label":"openConfirm","signature":["(message: string | ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.MountPoint","text":"MountPoint"},", options?: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.OverlayModalConfirmOptions","text":"OverlayModalConfirmOptions"}," | undefined) => Promise"],"description":["\nOpens a confirmation modal with the given text or mountpoint as a message.\nReturns a Promise resolving to `true` if user confirmed or `false` otherwise.\n"],"children":[{"type":"CompoundType","label":"message","isRequired":true,"signature":["string | ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.MountPoint","text":"MountPoint"},""],"description":[],"source":{"path":"src/core/public/overlays/modal/modal_service.tsx","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L94"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.OverlayModalConfirmOptions","text":"OverlayModalConfirmOptions"}," | undefined"],"description":[],"source":{"path":"src/core/public/overlays/modal/modal_service.tsx","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L94"}}],"tags":["link","link"],"returnComment":[],"source":{"path":"src/core/public/overlays/modal/modal_service.tsx","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L94"}}],"source":{"path":"src/core/public/overlays/modal/modal_service.tsx","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/overlays/modal/modal_service.tsx#L77"},"initialIsOpen":false},{"id":"def-public.ToastOptions","type":"Interface","label":"ToastOptions","description":["\nOptions available for {@link IToasts} APIs."],"children":[{"id":"def-public.ToastOptions.toastLifeTimeMs","type":"number","label":"toastLifeTimeMs","description":["\nHow long should the toast remain on screen."],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L51"},"signature":["number | undefined"]}],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L47"},"initialIsOpen":false},{"id":"def-public.ErrorToastOptions","type":"Interface","label":"ErrorToastOptions","signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ErrorToastOptions","text":"ErrorToastOptions"}," extends ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastOptions","text":"ToastOptions"}],"description":["\nOptions available for {@link IToasts} error APIs."],"children":[{"id":"def-public.ErrorToastOptions.title","type":"string","label":"title","description":["\nThe title of the toast and the dialog when expanding the message."],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L62"}},{"id":"def-public.ErrorToastOptions.toastMessage","type":"string","label":"toastMessage","description":["\nThe message to be shown in the toast. If this is not specified the error's\nmessage will be shown in the toast instead. Overwriting that message can\nbe used to provide more user-friendly toasts. If you specify this, the error\nmessage will still be shown in the detailed error modal."],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L69"},"signature":["string | undefined"]}],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L58"},"initialIsOpen":false},{"id":"def-public.CoreSetup","type":"Interface","label":"CoreSetup","signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreSetup","text":"CoreSetup"},""],"description":["\nCore services exposed to the `Plugin` setup lifecycle\n"],"children":[{"id":"def-public.CoreSetup.application","type":"Object","label":"application","description":["{@link ApplicationSetup}"],"source":{"path":"src/core/public/index.ts","lineNumber":208,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L208"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.ApplicationSetup","text":"ApplicationSetup"}]},{"id":"def-public.CoreSetup.fatalErrors","type":"Object","label":"fatalErrors","description":["{@link FatalErrorsSetup}"],"source":{"path":"src/core/public/index.ts","lineNumber":210,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L210"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.FatalErrorsSetup","text":"FatalErrorsSetup"}]},{"id":"def-public.CoreSetup.http","type":"Object","label":"http","description":["{@link HttpSetup}"],"source":{"path":"src/core/public/index.ts","lineNumber":212,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L212"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpSetup","text":"HttpSetup"}]},{"id":"def-public.CoreSetup.notifications","type":"Object","label":"notifications","description":["{@link NotificationsSetup}"],"source":{"path":"src/core/public/index.ts","lineNumber":214,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L214"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.NotificationsSetup","text":"NotificationsSetup"}]},{"id":"def-public.CoreSetup.uiSettings","type":"Object","label":"uiSettings","description":["{@link IUiSettingsClient}"],"source":{"path":"src/core/public/index.ts","lineNumber":216,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L216"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.IUiSettingsClient","text":"IUiSettingsClient"}]},{"id":"def-public.CoreSetup.injectedMetadata","type":"Object","label":"injectedMetadata","description":["\nexposed temporarily until https://github.com/elastic/kibana/issues/41990 done\nuse *only* to retrieve config values. There is no way to set injected values\nin the new platform."],"source":{"path":"src/core/public/index.ts","lineNumber":223,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L223"},"signature":["{ getInjectedVar: (name: string, defaultValue?: any) => unknown; }"]},{"id":"def-public.CoreSetup.getStartServices","type":"Function","label":"getStartServices","description":["{@link StartServicesAccessor}"],"source":{"path":"src/core/public/index.ts","lineNumber":227,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L227"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.StartServicesAccessor","text":"StartServicesAccessor"},""]}],"source":{"path":"src/core/public/index.ts","lineNumber":206,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L206"},"initialIsOpen":false},{"id":"def-public.CoreStart","type":"Interface","label":"CoreStart","description":["\nCore services exposed to the `Plugin` start lifecycle\n"],"children":[{"id":"def-public.CoreStart.application","type":"Object","label":"application","description":["{@link ApplicationStart}"],"source":{"path":"src/core/public/index.ts","lineNumber":253,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L253"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.ApplicationStart","text":"ApplicationStart"}]},{"id":"def-public.CoreStart.chrome","type":"Object","label":"chrome","description":["{@link ChromeStart}"],"source":{"path":"src/core/public/index.ts","lineNumber":255,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L255"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeStart","text":"ChromeStart"}]},{"id":"def-public.CoreStart.docLinks","type":"Object","label":"docLinks","description":["{@link DocLinksStart}"],"source":{"path":"src/core/public/index.ts","lineNumber":257,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L257"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.DocLinksStart","text":"DocLinksStart"}]},{"id":"def-public.CoreStart.http","type":"Object","label":"http","description":["{@link HttpStart}"],"source":{"path":"src/core/public/index.ts","lineNumber":259,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L259"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpSetup","text":"HttpSetup"}]},{"id":"def-public.CoreStart.savedObjects","type":"Object","label":"savedObjects","description":["{@link SavedObjectsStart}"],"source":{"path":"src/core/public/index.ts","lineNumber":261,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L261"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SavedObjectsStart","text":"SavedObjectsStart"}]},{"id":"def-public.CoreStart.i18n","type":"Object","label":"i18n","description":["{@link I18nStart}"],"source":{"path":"src/core/public/index.ts","lineNumber":263,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L263"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.I18nStart","text":"I18nStart"}]},{"id":"def-public.CoreStart.notifications","type":"Object","label":"notifications","description":["{@link NotificationsStart}"],"source":{"path":"src/core/public/index.ts","lineNumber":265,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L265"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.NotificationsStart","text":"NotificationsStart"}]},{"id":"def-public.CoreStart.overlays","type":"Object","label":"overlays","description":["{@link OverlayStart}"],"source":{"path":"src/core/public/index.ts","lineNumber":267,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L267"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.OverlayStart","text":"OverlayStart"}]},{"id":"def-public.CoreStart.uiSettings","type":"Object","label":"uiSettings","description":["{@link IUiSettingsClient}"],"source":{"path":"src/core/public/index.ts","lineNumber":269,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L269"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.IUiSettingsClient","text":"IUiSettingsClient"}]},{"id":"def-public.CoreStart.fatalErrors","type":"Object","label":"fatalErrors","description":["{@link FatalErrorsStart}"],"source":{"path":"src/core/public/index.ts","lineNumber":271,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L271"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.FatalErrorsSetup","text":"FatalErrorsSetup"}]},{"id":"def-public.CoreStart.injectedMetadata","type":"Object","label":"injectedMetadata","description":["\nexposed temporarily until https://github.com/elastic/kibana/issues/41990 done\nuse *only* to retrieve config values. There is no way to set injected values\nin the new platform."],"source":{"path":"src/core/public/index.ts","lineNumber":278,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L278"},"signature":["{ getInjectedVar: (name: string, defaultValue?: any) => unknown; }"]}],"source":{"path":"src/core/public/index.ts","lineNumber":251,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L251"},"initialIsOpen":false},{"id":"def-public.Capabilities","type":"Interface","label":"Capabilities","description":["\nThe read-only set of capabilities available for the current UI session.\nCapabilities are simple key-value pairs of (string, boolean), where the string denotes the capability ID,\nand the boolean is a flag indicating if the capability is enabled or disabled.\n"],"children":[{"id":"def-public.Capabilities.navLinks","type":"Object","label":"navLinks","description":["Navigation link capabilities."],"source":{"path":"src/core/types/capabilities.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/capabilities.ts#L18"},"signature":["Record"]},{"id":"def-public.Capabilities.management","type":"Object","label":"management","description":["Management section capabilities."],"source":{"path":"src/core/types/capabilities.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/capabilities.ts#L21"},"signature":["{ [sectionId: string]: Record; }"]},{"id":"def-public.Capabilities.catalogue","type":"Object","label":"catalogue","description":["Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options."],"source":{"path":"src/core/types/capabilities.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/capabilities.ts#L26"},"signature":["Record"]},{"id":"def-public.Capabilities.Unnamed","type":"Any","label":"Unnamed","description":["Custom capabilities, registered by plugins."],"source":{"path":"src/core/types/capabilities.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/capabilities.ts#L29"},"signature":["any"]}],"source":{"path":"src/core/types/capabilities.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/capabilities.ts#L16"},"initialIsOpen":false},{"id":"def-public.DocLinksStart","type":"Interface","label":"DocLinksStart","description":[],"children":[{"id":"def-public.DocLinksStart.DOC_LINK_VERSION","type":"string","label":"DOC_LINK_VERSION","description":[],"source":{"path":"src/core/public/doc_links/doc_links_service.ts","lineNumber":280,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/doc_links/doc_links_service.ts#L280"}},{"id":"def-public.DocLinksStart.ELASTIC_WEBSITE_URL","type":"string","label":"ELASTIC_WEBSITE_URL","description":[],"source":{"path":"src/core/public/doc_links/doc_links_service.ts","lineNumber":281,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/doc_links/doc_links_service.ts#L281"}},{"id":"def-public.DocLinksStart.links","type":"Object","label":"links","description":[],"source":{"path":"src/core/public/doc_links/doc_links_service.ts","lineNumber":282,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/doc_links/doc_links_service.ts#L282"},"signature":["{ readonly dashboard: { readonly guide: string; readonly drilldowns: string; readonly drilldownsTriggerPicker: string; readonly urlDrilldownTemplateSyntax: string; readonly urlDrilldownVariables: string; }; readonly discover: Record; readonly filebeat: { readonly base: string; readonly installation: string; readonly configuration: string; readonly elasticsearchOutput: string; readonly elasticsearchModule: string; readonly startup: string; readonly exportedFields: string; }; readonly auditbeat: { readonly base: string; }; readonly metricbeat: { readonly base: string; readonly configure: string; readonly httpEndpoint: string; readonly install: string; readonly start: string; }; readonly enterpriseSearch: { readonly base: string; readonly appSearchBase: string; readonly workplaceSearchBase: string; }; readonly heartbeat: { readonly base: string; }; readonly logstash: { readonly base: string; }; readonly functionbeat: { readonly base: string; }; readonly winlogbeat: { readonly base: string; }; readonly aggs: { readonly composite: string; readonly composite_missing_bucket: string; readonly date_histogram: string; readonly date_range: string; readonly date_format_pattern: string; readonly filter: string; readonly filters: string; readonly geohash_grid: string; readonly histogram: string; readonly ip_range: string; readonly range: string; readonly significant_terms: string; readonly terms: string; readonly avg: string; readonly avg_bucket: string; readonly max_bucket: string; readonly min_bucket: string; readonly sum_bucket: string; readonly cardinality: string; readonly count: string; readonly cumulative_sum: string; readonly derivative: string; readonly geo_bounds: string; readonly geo_centroid: string; readonly max: string; readonly median: string; readonly min: string; readonly moving_avg: string; readonly percentile_ranks: string; readonly serial_diff: string; readonly std_dev: string; readonly sum: string; readonly top_hits: string; }; readonly runtimeFields: string; readonly scriptedFields: { readonly scriptFields: string; readonly scriptAggs: string; readonly painless: string; readonly painlessApi: string; readonly painlessLangSpec: string; readonly painlessSyntax: string; readonly painlessWalkthrough: string; readonly luceneExpressions: string; }; readonly indexPatterns: { readonly loadingData: string; readonly introduction: string; }; readonly addData: string; readonly kibana: string; readonly elasticsearch: Record; readonly siem: { readonly guide: string; readonly gettingStarted: string; }; readonly query: { readonly eql: string; readonly luceneQuerySyntax: string; readonly queryDsl: string; readonly kueryQuerySyntax: string; }; readonly date: { readonly dateMath: string; readonly dateMathIndexNames: string; }; readonly management: Record; readonly ml: Record; readonly transforms: Record; readonly visualize: Record; readonly apis: Readonly<{ createIndex: string; createSnapshotLifecyclePolicy: string; createRoleMapping: string; createRoleMappingTemplates: string; createApiKey: string; createPipeline: string; createTransformRequest: string; cronExpressions: string; executeWatchActionModes: string; indexExists: string; openIndex: string; putComponentTemplate: string; painlessExecute: string; painlessExecuteAPIContexts: string; putComponentTemplateMetadata: string; putSnapshotLifecyclePolicy: string; putWatch: string; updateTransform: string; }>; readonly observability: Record; readonly alerting: Record; readonly maps: Record; readonly monitoring: Record; readonly security: Readonly<{ apiKeyServiceSettings: string; clusterPrivileges: string; elasticsearchSettings: string; elasticsearchEnableSecurity: string; indicesPrivileges: string; kibanaTLS: string; kibanaPrivileges: string; mappingRoles: string; mappingRolesFieldRules: string; runAsPrivilege: string; }>; readonly watcher: Record; readonly ccs: Record; readonly plugins: Record; readonly snapshotRestore: Record; }"]}],"source":{"path":"src/core/public/doc_links/doc_links_service.ts","lineNumber":279,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/doc_links/doc_links_service.ts#L279"},"initialIsOpen":false},{"id":"def-public.FatalErrorInfo","type":"Interface","label":"FatalErrorInfo","description":["\nRepresents the `message` and `stack` of a fatal Error\n"],"children":[{"id":"def-public.FatalErrorInfo.message","type":"string","label":"message","description":[],"source":{"path":"src/core/public/fatal_errors/get_error_info.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/fatal_errors/get_error_info.ts#L73"}},{"id":"def-public.FatalErrorInfo.stack","type":"string","label":"stack","description":[],"source":{"path":"src/core/public/fatal_errors/get_error_info.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/fatal_errors/get_error_info.ts#L74"},"signature":["string | undefined"]}],"source":{"path":"src/core/public/fatal_errors/get_error_info.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/fatal_errors/get_error_info.ts#L72"},"initialIsOpen":false},{"id":"def-public.FatalErrorsSetup","type":"Interface","label":"FatalErrorsSetup","description":["\nFatalErrors stop the Kibana Public Core and displays a fatal error screen\nwith details about the Kibana build and the error.\n"],"children":[{"id":"def-public.FatalErrorsSetup.add","type":"Function","label":"add","description":["\nAdd a new fatal error. This will stop the Kibana Public Core and display\na fatal error screen with details about the Kibana build and the error.\n"],"source":{"path":"src/core/public/fatal_errors/fatal_errors_service.tsx","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/fatal_errors/fatal_errors_service.tsx#L38"},"signature":["(error: string | Error, source?: string | undefined) => never"]},{"id":"def-public.FatalErrorsSetup.get$","type":"Function","label":"get$","description":["\nAn Observable that will emit whenever a fatal error is added with `add()`"],"source":{"path":"src/core/public/fatal_errors/fatal_errors_service.tsx","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/fatal_errors/fatal_errors_service.tsx#L43"},"signature":["() => ","Observable","<",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.FatalErrorInfo","text":"FatalErrorInfo"},">"]}],"source":{"path":"src/core/public/fatal_errors/fatal_errors_service.tsx","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/fatal_errors/fatal_errors_service.tsx#L30"},"initialIsOpen":false},{"id":"def-public.I18nStart","type":"Interface","label":"I18nStart","description":["\nI18nStart.Context is required by any localizable React component from \\@kbn/i18n and \\@elastic/eui packages\nand is supposed to be used as the topmost component for any i18n-compatible React tree.\n"],"children":[{"id":"def-public.I18nStart.Context","type":"Function","label":"Context","description":["\nReact Context provider required as the topmost component for any i18n-compatible React tree."],"source":{"path":"src/core/public/i18n/i18n_service.tsx","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/i18n/i18n_service.tsx#L65"},"signature":["({ children }: { children: React.ReactNode; }) => JSX.Element"]}],"source":{"path":"src/core/public/i18n/i18n_service.tsx","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/i18n/i18n_service.tsx#L61"},"initialIsOpen":false},{"id":"def-public.NotificationsSetup","type":"Interface","label":"NotificationsSetup","description":[],"children":[{"id":"def-public.NotificationsSetup.toasts","type":"Object","label":"toasts","description":["{@link ToastsSetup}"],"source":{"path":"src/core/public/notifications/notifications_service.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/notifications_service.ts#L78"},"signature":["Pick<",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastsApi","text":"ToastsApi"},", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">"]}],"source":{"path":"src/core/public/notifications/notifications_service.ts","lineNumber":76,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/notifications_service.ts#L76"},"initialIsOpen":false},{"id":"def-public.NotificationsStart","type":"Interface","label":"NotificationsStart","description":[],"children":[{"id":"def-public.NotificationsStart.toasts","type":"Object","label":"toasts","description":["{@link ToastsStart}"],"source":{"path":"src/core/public/notifications/notifications_service.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/notifications_service.ts#L84"},"signature":["Pick<",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastsApi","text":"ToastsApi"},", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">"]}],"source":{"path":"src/core/public/notifications/notifications_service.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/notifications_service.ts#L82"},"initialIsOpen":false},{"id":"def-public.Plugin","type":"Interface","label":"Plugin","signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Plugin","text":"Plugin"},""],"description":["\nThe interface that should be returned by a `PluginInitializer`.\n"],"children":[{"id":"def-public.Plugin.setup","type":"Function","label":"setup","signature":["(core: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreSetup","text":"CoreSetup"},", plugins: TPluginsSetup) => TSetup"],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreSetup","text":"CoreSetup"},""],"description":[],"source":{"path":"src/core/public/plugins/plugin.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L28"}},{"type":"Uncategorized","label":"plugins","isRequired":true,"signature":["TPluginsSetup"],"description":[],"source":{"path":"src/core/public/plugins/plugin.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L28"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/plugins/plugin.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L28"}},{"id":"def-public.Plugin.start","type":"Function","label":"start","signature":["(core: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreStart","text":"CoreStart"},", plugins: TPluginsStart) => TStart"],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreStart","text":"CoreStart"}],"description":[],"source":{"path":"src/core/public/plugins/plugin.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L29"}},{"type":"Uncategorized","label":"plugins","isRequired":true,"signature":["TPluginsStart"],"description":[],"source":{"path":"src/core/public/plugins/plugin.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L29"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/plugins/plugin.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L29"}},{"id":"def-public.Plugin.stop","type":"Function","label":"stop","signature":["(() => void) | undefined"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/public/plugins/plugin.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L30"}}],"source":{"path":"src/core/public/plugins/plugin.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L22"},"initialIsOpen":false},{"id":"def-public.AsyncPlugin","type":"Interface","label":"AsyncPlugin","signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.AsyncPlugin","text":"AsyncPlugin"},""],"description":["\nA plugin with asynchronous lifecycle methods.\n"],"children":[{"id":"def-public.AsyncPlugin.setup","type":"Function","label":"setup","signature":["(core: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreSetup","text":"CoreSetup"},", plugins: TPluginsSetup) => TSetup | Promise"],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreSetup","text":"CoreSetup"},""],"description":[],"source":{"path":"src/core/public/plugins/plugin.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L45"}},{"type":"Uncategorized","label":"plugins","isRequired":true,"signature":["TPluginsSetup"],"description":[],"source":{"path":"src/core/public/plugins/plugin.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L45"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/plugins/plugin.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L45"}},{"id":"def-public.AsyncPlugin.start","type":"Function","label":"start","signature":["(core: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreStart","text":"CoreStart"},", plugins: TPluginsStart) => TStart | Promise"],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreStart","text":"CoreStart"}],"description":[],"source":{"path":"src/core/public/plugins/plugin.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L46"}},{"type":"Uncategorized","label":"plugins","isRequired":true,"signature":["TPluginsStart"],"description":[],"source":{"path":"src/core/public/plugins/plugin.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L46"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/plugins/plugin.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L46"}},{"id":"def-public.AsyncPlugin.stop","type":"Function","label":"stop","signature":["(() => void) | undefined"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/public/plugins/plugin.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L47"}}],"source":{"path":"src/core/public/plugins/plugin.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L39"},"initialIsOpen":false},{"id":"def-public.PluginInitializerContext","type":"Interface","label":"PluginInitializerContext","signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.PluginInitializerContext","text":"PluginInitializerContext"},""],"description":["\nThe available core services passed to a `PluginInitializer`\n"],"children":[{"id":"def-public.PluginInitializerContext.opaqueId","type":"Uncategorized","label":"opaqueId","description":["\nA symbol used to identify this plugin in the system. Needed when registering handlers or context providers."],"source":{"path":"src/core/public/plugins/plugin_context.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin_context.ts#L26"},"signature":["symbol"]},{"id":"def-public.PluginInitializerContext.env","type":"Object","label":"env","description":[],"source":{"path":"src/core/public/plugins/plugin_context.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin_context.ts#L27"},"signature":["{ mode: Readonly<","EnvironmentMode",">; packageInfo: Readonly<","PackageInfo",">; }"]},{"id":"def-public.PluginInitializerContext.config","type":"Object","label":"config","description":[],"source":{"path":"src/core/public/plugins/plugin_context.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin_context.ts#L31"},"signature":["{ get: () => T; }"]}],"source":{"path":"src/core/public/plugins/plugin_context.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin_context.ts#L22"},"initialIsOpen":false},{"id":"def-public.IUiSettingsClient","type":"Interface","label":"IUiSettingsClient","description":["\nClient-side client that provides access to the advanced settings stored in elasticsearch.\nThe settings provide control over the behavior of the Kibana application.\nFor example, a user can specify how to display numeric or date fields.\nUsers can adjust the settings via Management UI.\n{@link IUiSettingsClient}\n"],"children":[{"id":"def-public.IUiSettingsClient.get","type":"Function","label":"get","description":["\nGets the value for a specific uiSetting. If this setting has no user-defined value\nthen the `defaultOverride` parameter is returned (and parsed if setting is of type\n\"json\" or \"number). If the parameter is not defined and the key is not registered\nby any plugin then an error is thrown, otherwise reads the default value defined by a plugin."],"source":{"path":"src/core/public/ui_settings/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L33"},"signature":["(key: string, defaultOverride?: T | undefined) => T"]},{"id":"def-public.IUiSettingsClient.get$","type":"Function","label":"get$","description":["\nGets an observable of the current value for a config key, and all updates to that config\nkey in the future. Providing a `defaultOverride` argument behaves the same as it does in #get()"],"source":{"path":"src/core/public/ui_settings/types.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L39"},"signature":["(key: string, defaultOverride?: T | undefined) => ","Observable",""]},{"id":"def-public.IUiSettingsClient.getAll","type":"Function","label":"getAll","description":["\nGets the metadata about all uiSettings, including the type, default value, and user value\nfor each key."],"source":{"path":"src/core/public/ui_settings/types.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L45"},"signature":["() => Readonly, \"type\" | \"options\" | \"description\" | \"name\" | \"order\" | \"value\" | \"category\" | \"metric\" | \"optionLabels\" | \"requiresPageReload\" | \"readonly\" | \"sensitive\" | \"deprecation\" | \"validation\"> & ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.UserProvidedValues","text":"UserProvidedValues"},">>"]},{"id":"def-public.IUiSettingsClient.set","type":"Function","label":"set","description":["\nSets the value for a uiSetting. If the setting is not registered by any plugin\nit will be stored as a custom setting. The new value will be synchronously available via\nthe `get()` method and sent to the server in the background. If the request to the\nserver fails then a updateErrors$ will be notified and the setting will be\nreverted to its value before `set()` was called."],"source":{"path":"src/core/public/ui_settings/types.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L54"},"signature":["(key: string, value: any) => Promise"]},{"id":"def-public.IUiSettingsClient.overrideLocalDefault","type":"Function","label":"overrideLocalDefault","description":["\nOverrides the default value for a setting in this specific browser tab. If the page\nis reloaded the default override is lost."],"source":{"path":"src/core/public/ui_settings/types.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L60"},"signature":["(key: string, newDefault: any) => void"]},{"id":"def-public.IUiSettingsClient.remove","type":"Function","label":"remove","description":["\nRemoves the user-defined value for a setting, causing it to revert to the default. This\nmethod behaves the same as calling `set(key, null)`, including the synchronization, custom\nsetting, and error behavior of that method."],"source":{"path":"src/core/public/ui_settings/types.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L67"},"signature":["(key: string) => Promise"]},{"id":"def-public.IUiSettingsClient.isDeclared","type":"Function","label":"isDeclared","description":["\nReturns true if the key is a \"known\" uiSetting, meaning it is either registered\nby any plugin or was previously added as a custom setting via the `set()` method."],"source":{"path":"src/core/public/ui_settings/types.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L73"},"signature":["(key: string) => boolean"]},{"id":"def-public.IUiSettingsClient.isDefault","type":"Function","label":"isDefault","description":["\nReturns true if the setting has no user-defined value or is unknown"],"source":{"path":"src/core/public/ui_settings/types.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L78"},"signature":["(key: string) => boolean"]},{"id":"def-public.IUiSettingsClient.isCustom","type":"Function","label":"isCustom","description":["\nReturns true if the setting wasn't registered by any plugin, but was either\nadded directly via `set()`, or is an unknown setting found in the uiSettings saved\nobject"],"source":{"path":"src/core/public/ui_settings/types.ts","lineNumber":85,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L85"},"signature":["(key: string) => boolean"]},{"id":"def-public.IUiSettingsClient.isOverridden","type":"Function","label":"isOverridden","description":["\nShows whether the uiSettings value set by the user."],"source":{"path":"src/core/public/ui_settings/types.ts","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L90"},"signature":["(key: string) => boolean"]},{"id":"def-public.IUiSettingsClient.getUpdate$","type":"Function","label":"getUpdate$","description":["\nReturns an Observable that notifies subscribers of each update to the uiSettings,\nincluding the key, newValue, and oldValue of the setting that changed."],"source":{"path":"src/core/public/ui_settings/types.ts","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L96"},"signature":["() => ","Observable","<{ key: string; newValue: T; oldValue: T; }>"]},{"id":"def-public.IUiSettingsClient.getSaved$","type":"Function","label":"getSaved$","description":["\nReturns an Observable that notifies subscribers of each update to the uiSettings,\nincluding the key, newValue, and oldValue of the setting that changed."],"source":{"path":"src/core/public/ui_settings/types.ts","lineNumber":106,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L106"},"signature":["() => ","Observable","<{ key: string; newValue: T; oldValue: T; }>"]},{"id":"def-public.IUiSettingsClient.getUpdateErrors$","type":"Function","label":"getUpdateErrors$","description":["\nReturns an Observable that notifies subscribers of each error while trying to update\nthe settings, containing the actual Error class."],"source":{"path":"src/core/public/ui_settings/types.ts","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L116"},"signature":["() => ","Observable",""]}],"source":{"path":"src/core/public/ui_settings/types.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L26"},"initialIsOpen":false},{"id":"def-public.UiSettingsState","type":"Interface","label":"UiSettingsState","description":[],"children":[{"id":"def-public.UiSettingsState.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/public/ui_settings/types.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L14"},"signature":["any"]}],"source":{"path":"src/core/public/ui_settings/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/ui_settings/types.ts#L13"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-public.UiSettingsType","type":"Type","label":"UiSettingsType","description":["\nUI element type to represent the settings."],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L16"},"signature":["\"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"json\" | \"image\" | \"select\" | \"array\" | \"markdown\""],"initialIsOpen":false},{"id":"def-public.StringValidation","type":"Type","label":"StringValidation","description":["\nAllows regex objects or a regex string"],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L108"},"signature":["StringValidationRegex"," | ","StringValidationRegexString"],"initialIsOpen":false},{"id":"def-public.SavedObjectAttribute","type":"Type","label":"SavedObjectAttribute","description":["\nType definition for a Saved Object attribute value\n"],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L27"},"signature":["undefined | null | string | number | false | true | ","SavedObjectAttributes"," | ","SavedObjectAttributeSingle","[]"],"initialIsOpen":false},{"id":"def-public.SavedObjectAttributeSingle","type":"Type","label":"SavedObjectAttributeSingle","description":["\nDon't use this type, it's simply a helper type for {@link SavedObjectAttribute}\n"],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L14"},"signature":["undefined | null | string | number | false | true | ","SavedObjectAttributes"],"initialIsOpen":false},{"id":"def-public.SavedObjectsNamespaceType","type":"Type","label":"SavedObjectsNamespaceType","description":["\nThe namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive:\n * single (default): This type of saved object is namespace-isolated, e.g., it exists in only one namespace.\n * multiple: This type of saved object is shareable, e.g., it can exist in one or more namespaces.\n * multiple-isolated: This type of saved object is namespace-isolated, e.g., it exists in only one namespace, but object IDs must be\n unique across all namespaces. This is intended to be an intermediate step when objects with a \"single\" namespace type are being\n converted to a \"multiple\" namespace type. In other words, objects with a \"multiple-isolated\" namespace type will be *share-capable*,\n but will not actually be shareable until the namespace type is changed to \"multiple\".\n * agnostic: This type of saved object is global.\n"],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":226,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L226"},"signature":["\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\""],"initialIsOpen":false},{"id":"def-public.SavedObjectsImportWarning","type":"Type","label":"SavedObjectsImportWarning","description":["\nComposite type of all the possible types of import warnings.\n\nSee {@link SavedObjectsImportSimpleWarning} and {@link SavedObjectsImportActionRequiredWarning}\nfor more details.\n"],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":218,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L218"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportSimpleWarning","text":"SavedObjectsImportSimpleWarning"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportActionRequiredWarning","text":"SavedObjectsImportActionRequiredWarning"}],"initialIsOpen":false},{"id":"def-public.Toast","type":"Type","label":"Toast","description":[],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L33"},"signature":["Pick & { title?: string | MountPoint | undefined; text?: string | MountPoint | undefined; } & { id: string; }"],"initialIsOpen":false},{"id":"def-public.ToastInput","type":"Type","label":"ToastInput","description":["\nInputs for {@link IToasts} APIs."],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L41"},"signature":["string | ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastInputFields","text":"ToastInputFields"}],"initialIsOpen":false},{"id":"def-public.IToasts","type":"Type","label":"IToasts","description":["\nMethods for adding and removing global toast messages. See {@link ToastsApi}."],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":85,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L85"},"signature":["{ get$: () => Rx.Observable; add: (toastOrTitle: ToastInput) => Toast; remove: (toastOrId: string | Toast) => void; addSuccess: (toastOrTitle: ToastInput, options?: ToastOptions | undefined) => Toast; addWarning: (toastOrTitle: ToastInput, options?: ToastOptions | undefined) => Toast; addDanger: (toastOrTitle: ToastInput, options?: ToastOptions | undefined) => Toast; addError: (error: Error, options: ErrorToastOptions) => Toast; addInfo: (toastOrTitle: ToastInput, options?: ToastOptions | undefined) => Toast; }"],"initialIsOpen":false},{"id":"def-public.ToastInputFields","type":"Type","label":"ToastInputFields","description":["\nAllowed fields for {@link ToastInput}.\n"],"source":{"path":"src/core/public/notifications/toasts/toasts_api.tsx","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_api.tsx#L28"},"signature":["Pick & { title?: string | MountPoint | undefined; text?: string | MountPoint | undefined; }"],"initialIsOpen":false},{"id":"def-public.ToastsSetup","type":"Type","label":"ToastsSetup","description":["\n{@link IToasts}"],"source":{"path":"src/core/public/notifications/toasts/toasts_service.tsx","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_service.tsx#L32"},"signature":["{ get$: () => ","Observable","<",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Toast","text":"Toast"},"[]>; add: (toastOrTitle: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastInput","text":"ToastInput"},") => ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Toast","text":"Toast"},"; remove: (toastOrId: string | ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Toast","text":"Toast"}],"initialIsOpen":false},{"id":"def-public.ToastsStart","type":"Type","label":"ToastsStart","description":["\n{@link IToasts}"],"source":{"path":"src/core/public/notifications/toasts/toasts_service.tsx","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/notifications/toasts/toasts_service.tsx#L38"},"signature":["{ get$: () => ","Observable","<",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Toast","text":"Toast"},"[]>; add: (toastOrTitle: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastInput","text":"ToastInput"},") => ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Toast","text":"Toast"},"; remove: (toastOrId: string | ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Toast","text":"Toast"}],"initialIsOpen":false},{"id":"def-public.MountPoint","type":"Type","label":"MountPoint","description":["\nA function that should mount DOM content inside the provided container element\nand return a handler to unmount it.\n"],"source":{"path":"src/core/public/types.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/types.ts#L27"},"signature":["(element: T) => ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.UnmountCallback","text":"UnmountCallback"}],"initialIsOpen":false},{"id":"def-public.UnmountCallback","type":"Type","label":"UnmountCallback","description":["\nA function that will unmount the element previously mounted by\nthe associated {@link MountPoint}\n"],"source":{"path":"src/core/public/types.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/types.ts#L35"},"signature":["() => void"],"initialIsOpen":false},{"id":"def-public.PublicUiSettingsParams","type":"Type","label":"PublicUiSettingsParams","description":["\nA sub-set of {@link UiSettingsParams} exposed to the client-side."],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L102"},"signature":["{ type?: \"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"json\" | \"image\" | \"select\" | \"array\" | \"markdown\" | undefined; options?: string[] | undefined; description?: string | undefined; name?: string | undefined; order?: number | undefined; value?: unknown; category?: string[] | undefined; metric?: { type: UiCounterMetricType; name: string; } | undefined; optionLabels?: Record | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; deprecation?: DeprecationSettings | undefined; validation?: ImageValidation | StringValidationRegex | StringValidationRegexString | undefined; }"],"initialIsOpen":false},{"id":"def-public.URL_MAX_LENGTH","type":"CompoundType","label":"URL_MAX_LENGTH","description":["\nThe max URL length allowed by the current browser. Should be used to display warnings to users when query parameters\ncause URL to exceed this limit."],"source":{"path":"src/core/public/core_app/errors/url_overflow.tsx","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/core_app/errors/url_overflow.tsx#L27"},"signature":["2000 | 25000"],"initialIsOpen":false},{"id":"def-public.StartServicesAccessor","type":"Type","label":"StartServicesAccessor","description":["\nAllows plugins to get access to APIs available in start inside async\nhandlers, such as {@link App.mount}. Promise will not resolve until Core\nand plugin dependencies have completed `start`.\n"],"source":{"path":"src/core/public/index.ts","lineNumber":237,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/index.ts#L237"},"signature":["() => Promise<[",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreStart","text":"CoreStart"},", TPluginsStart, TStart]>"],"initialIsOpen":false},{"id":"def-public.FatalErrorsStart","type":"Type","label":"FatalErrorsStart","description":["\nFatalErrors stop the Kibana Public Core and displays a fatal error screen\nwith details about the Kibana build and the error.\n"],"source":{"path":"src/core/public/fatal_errors/fatal_errors_service.tsx","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/fatal_errors/fatal_errors_service.tsx#L52"},"signature":["FatalErrorsSetup"],"initialIsOpen":false},{"id":"def-public.PluginInitializer","type":"Type","label":"PluginInitializer","description":["\nThe `plugin` export at the root of a plugin's `public` directory should conform\nto this interface.\n"],"source":{"path":"src/core/public/plugins/plugin.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/plugins/plugin.ts#L56"},"signature":["(core: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.PluginInitializerContext","text":"PluginInitializerContext"},") => ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Plugin","text":"Plugin"}," | ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.AsyncPlugin","text":"AsyncPlugin"},""],"initialIsOpen":false},{"id":"def-public.PluginOpaqueId","type":"Type","label":"PluginOpaqueId","description":[],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L84"},"signature":["symbol"],"initialIsOpen":false}],"objects":[{"id":"def-public.DEFAULT_APP_CATEGORIES","type":"Object","label":"DEFAULT_APP_CATEGORIES","description":[],"source":{"path":"src/core/utils/default_app_categories.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/utils/default_app_categories.ts#L13"},"signature":["Record"],"initialIsOpen":false}]},"server":{"classes":[{"id":"def-server.ConfigService","type":"Class","label":"ConfigService","description":[],"signature":["ConfigService"],"children":[{"id":"def-server.ConfigService.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"rawConfigProvider","isRequired":true,"signature":["Pick<","RawConfigService",", \"getConfig$\">"],"description":[],"source":{"path":"node_modules/@kbn/config/target/config_service.d.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/config_service.d.ts#L26"}},{"type":"Object","label":"env","isRequired":true,"signature":["Env"],"description":[],"source":{"path":"node_modules/@kbn/config/target/config_service.d.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/config_service.d.ts#L26"}},{"type":"Object","label":"logger","isRequired":true,"signature":["LoggerFactory"],"description":[],"source":{"path":"node_modules/@kbn/config/target/config_service.d.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/config_service.d.ts#L26"}}],"tags":[],"returnComment":[],"source":{"path":"node_modules/@kbn/config/target/config_service.d.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/config_service.d.ts#L26"}},{"id":"def-server.ConfigService.setSchema","type":"Function","label":"setSchema","signature":["(path: string | string[], schema: ","Type",") => void"],"description":["\nSet config schema for a path and performs its validation"],"children":[{"type":"CompoundType","label":"path","isRequired":true,"signature":["string | string[]"],"description":[],"source":{"path":"node_modules/@kbn/config/target/config_service.d.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/config_service.d.ts#L30"}},{"type":"Object","label":"schema","isRequired":true,"signature":["Type",""],"description":[],"source":{"path":"node_modules/@kbn/config/target/config_service.d.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/config_service.d.ts#L30"}}],"tags":[],"returnComment":[],"source":{"path":"node_modules/@kbn/config/target/config_service.d.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/config_service.d.ts#L30"}},{"id":"def-server.ConfigService.addDeprecationProvider","type":"Function","label":"addDeprecationProvider","signature":["(path: string | string[], provider: ","ConfigDeprecationProvider",") => void"],"description":["\nRegister a {@link ConfigDeprecationProvider} to be used when validating and migrating the configuration"],"children":[{"type":"CompoundType","label":"path","isRequired":true,"signature":["string | string[]"],"description":[],"source":{"path":"node_modules/@kbn/config/target/config_service.d.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/config_service.d.ts#L34"}},{"type":"Function","label":"provider","isRequired":true,"signature":["ConfigDeprecationProvider"],"description":[],"source":{"path":"node_modules/@kbn/config/target/config_service.d.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/config_service.d.ts#L34"}}],"tags":[],"returnComment":[],"source":{"path":"node_modules/@kbn/config/target/config_service.d.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/config_service.d.ts#L34"}},{"id":"def-server.ConfigService.validate","type":"Function","label":"validate","signature":["() => Promise"],"description":["\nValidate the whole configuration and log the deprecation warnings.\n\nThis must be done after every schemas and deprecation providers have been registered."],"children":[],"tags":[],"returnComment":[],"source":{"path":"node_modules/@kbn/config/target/config_service.d.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/config_service.d.ts#L40"}},{"id":"def-server.ConfigService.getConfig$","type":"Function","label":"getConfig$","signature":["() => ","Observable","<","Config",">"],"description":["\nReturns the full config object observable. This is not intended for\n\"normal use\", but for internal features that _need_ access to the full object."],"children":[],"tags":[],"returnComment":[],"source":{"path":"node_modules/@kbn/config/target/config_service.d.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/config_service.d.ts#L45"}},{"id":"def-server.ConfigService.atPath","type":"Function","label":"atPath","signature":["(path: string | string[]) => ","Observable",""],"description":["\nReads the subset of the config at the specified `path` and validates it\nagainst its registered schema.\n"],"children":[{"type":"CompoundType","label":"path","isRequired":true,"signature":["string | string[]"],"description":["- The path to the desired subset of the config."],"source":{"path":"node_modules/@kbn/config/target/config_service.d.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/config_service.d.ts#L52"}}],"tags":[],"returnComment":[],"source":{"path":"node_modules/@kbn/config/target/config_service.d.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/config_service.d.ts#L52"}},{"id":"def-server.ConfigService.atPathSync","type":"Function","label":"atPathSync","signature":["(path: string | string[]) => TSchema"],"description":["\nSimilar to {@link atPath}, but return the last emitted value synchronously instead of an\nobservable.\n"],"children":[{"type":"CompoundType","label":"path","isRequired":true,"signature":["string | string[]"],"description":["- The path to the desired subset of the config."],"source":{"path":"node_modules/@kbn/config/target/config_service.d.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/config_service.d.ts#L59"}}],"tags":[],"returnComment":[],"source":{"path":"node_modules/@kbn/config/target/config_service.d.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/config_service.d.ts#L59"}},{"id":"def-server.ConfigService.isEnabledAtPath","type":"Function","label":"isEnabledAtPath","signature":["(path: string | string[]) => Promise"],"description":[],"children":[{"type":"CompoundType","label":"path","isRequired":true,"signature":["string | string[]"],"description":[],"source":{"path":"node_modules/@kbn/config/target/config_service.d.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/config_service.d.ts#L60"}}],"tags":[],"returnComment":[],"source":{"path":"node_modules/@kbn/config/target/config_service.d.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/config_service.d.ts#L60"}},{"id":"def-server.ConfigService.getUnusedPaths","type":"Function","label":"getUnusedPaths","signature":["() => Promise"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"node_modules/@kbn/config/target/config_service.d.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/config_service.d.ts#L61"}},{"id":"def-server.ConfigService.getUsedPaths","type":"Function","label":"getUsedPaths","signature":["() => Promise"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"node_modules/@kbn/config/target/config_service.d.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/config_service.d.ts#L62"}}],"source":{"path":"node_modules/@kbn/config/target/config_service.d.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/config_service.d.ts#L11"},"initialIsOpen":false},{"id":"def-server.CspConfig","type":"Class","label":"CspConfig","description":["\nCSP configuration for use in Kibana."],"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CspConfig","text":"CspConfig"}," implements ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ICspConfig","text":"ICspConfig"}],"children":[{"id":"def-server.CspConfig.DEFAULT","type":"Object","label":"DEFAULT","description":[],"source":{"path":"src/core/server/csp/csp_config.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/csp/csp_config.ts#L47"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CspConfig","text":"CspConfig"}]},{"id":"def-server.CspConfig.rules","type":"Array","label":"rules","description":[],"source":{"path":"src/core/server/csp/csp_config.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/csp/csp_config.ts#L49"},"signature":["string[]"]},{"id":"def-server.CspConfig.strict","type":"boolean","label":"strict","description":[],"source":{"path":"src/core/server/csp/csp_config.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/csp/csp_config.ts#L50"}},{"id":"def-server.CspConfig.warnLegacyBrowsers","type":"boolean","label":"warnLegacyBrowsers","description":[],"source":{"path":"src/core/server/csp/csp_config.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/csp/csp_config.ts#L51"}},{"id":"def-server.CspConfig.header","type":"string","label":"header","description":[],"source":{"path":"src/core/server/csp/csp_config.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/csp/csp_config.ts#L52"}},{"id":"def-server.CspConfig.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":["\nReturns the default CSP configuration when passed with no config"],"children":[{"type":"Object","label":"rawCspConfig","isRequired":true,"signature":["Partial>"],"description":[],"source":{"path":"src/core/server/csp/csp_config.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/csp/csp_config.ts#L58"}}],"tags":["internal"],"returnComment":[],"source":{"path":"src/core/server/csp/csp_config.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/csp/csp_config.ts#L58"}}],"source":{"path":"src/core/server/csp/csp_config.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/csp/csp_config.ts#L46"},"initialIsOpen":false},{"id":"def-server.LegacyClusterClient","type":"Class","label":"LegacyClusterClient","description":["\n{@inheritDoc IClusterClient}"],"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.LegacyClusterClient","text":"LegacyClusterClient"}," implements Pick<",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.LegacyClusterClient","text":"LegacyClusterClient"},", \"callAsInternalUser\" | \"asScoped\">"],"children":[{"id":"def-server.LegacyClusterClient.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"CompoundType","label":"config","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.LegacyElasticsearchClientConfig","text":"LegacyElasticsearchClientConfig"}],"description":[],"source":{"path":"src/core/server/elasticsearch/legacy/cluster_client.ts","lineNumber":122,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L122"}},{"type":"Object","label":"log","isRequired":true,"signature":["Logger"],"description":[],"source":{"path":"src/core/server/elasticsearch/legacy/cluster_client.ts","lineNumber":123,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L123"}},{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/elasticsearch/legacy/cluster_client.ts","lineNumber":124,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L124"}},{"type":"Function","label":"getAuthHeaders","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.GetAuthHeaders","text":"GetAuthHeaders"}],"description":[],"source":{"path":"src/core/server/elasticsearch/legacy/cluster_client.ts","lineNumber":125,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L125"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/elasticsearch/legacy/cluster_client.ts","lineNumber":121,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L121"}},{"id":"def-server.LegacyClusterClient.callAsInternalUser","type":"Function","children":[{"type":"string","label":"endpoint","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/elasticsearch/legacy/cluster_client.ts","lineNumber":141,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L141"}},{"type":"Object","label":"clientParams","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/core/server/elasticsearch/legacy/cluster_client.ts","lineNumber":142,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L142"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.LegacyCallAPIOptions","text":"LegacyCallAPIOptions"}," | undefined"],"description":[],"source":{"path":"src/core/server/elasticsearch/legacy/cluster_client.ts","lineNumber":143,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L143"}}],"signature":["(endpoint: string, clientParams?: Record, options?: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.LegacyCallAPIOptions","text":"LegacyCallAPIOptions"}," | undefined) => Promise"],"description":["\nCalls specified endpoint with provided clientParams on behalf of the\nKibana internal user.\nSee {@link LegacyAPICaller}."],"label":"callAsInternalUser","source":{"path":"src/core/server/elasticsearch/legacy/cluster_client.ts","lineNumber":140,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L140"},"returnComment":[]},{"id":"def-server.LegacyClusterClient.close","type":"Function","label":"close","signature":["() => void"],"description":["\nCloses the cluster client. After that client cannot be used and one should\ncreate a new client instance to be able to interact with Elasticsearch API."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/server/elasticsearch/legacy/cluster_client.ts","lineNumber":158,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L158"}},{"id":"def-server.LegacyClusterClient.asScoped","type":"Function","label":"asScoped","signature":["(request?: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.FakeRequest","text":"FakeRequest"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.LegacyRequest","text":"LegacyRequest"}," | undefined) => Pick<",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.LegacyScopedClusterClient","text":"LegacyScopedClusterClient"},", \"callAsCurrentUser\" | \"callAsInternalUser\">"],"description":["\nCreates an instance of {@link ILegacyScopedClusterClient} based on the configuration the\ncurrent cluster client that exposes additional `callAsCurrentUser` method\nscoped to the provided req. Consumers shouldn't worry about closing\nscoped client instances, these will be automatically closed as soon as the\noriginal cluster client isn't needed anymore and closed.\n"],"children":[{"type":"CompoundType","label":"request","isRequired":false,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.FakeRequest","text":"FakeRequest"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.LegacyRequest","text":"LegacyRequest"}," | undefined"],"description":["- Request the `IScopedClusterClient` instance will be scoped to.\nSupports request optionality, Legacy.Request & FakeRequest for BWC with LegacyPlatform"],"source":{"path":"src/core/server/elasticsearch/legacy/cluster_client.ts","lineNumber":181,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L181"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/elasticsearch/legacy/cluster_client.ts","lineNumber":181,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L181"}}],"source":{"path":"src/core/server/elasticsearch/legacy/cluster_client.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L104"},"initialIsOpen":false},{"id":"def-server.LegacyScopedClusterClient","type":"Class","label":"LegacyScopedClusterClient","description":["\n{@inheritDoc IScopedClusterClient}"],"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.LegacyScopedClusterClient","text":"LegacyScopedClusterClient"}," implements Pick<",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.LegacyScopedClusterClient","text":"LegacyScopedClusterClient"},", \"callAsCurrentUser\" | \"callAsInternalUser\">"],"children":[{"id":"def-server.LegacyScopedClusterClient.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Function","label":"internalAPICaller","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.LegacyAPICaller","text":"LegacyAPICaller"}],"description":[],"source":{"path":"src/core/server/elasticsearch/legacy/scoped_cluster_client.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L36"}},{"type":"Function","label":"scopedAPICaller","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.LegacyAPICaller","text":"LegacyAPICaller"}],"description":[],"source":{"path":"src/core/server/elasticsearch/legacy/scoped_cluster_client.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L37"}},{"type":"CompoundType","label":"headers","isRequired":false,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.Headers","text":"Headers"}," | undefined"],"description":[],"source":{"path":"src/core/server/elasticsearch/legacy/scoped_cluster_client.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L38"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/elasticsearch/legacy/scoped_cluster_client.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L35"}},{"id":"def-server.LegacyScopedClusterClient.callAsInternalUser","type":"Function","label":"callAsInternalUser","signature":["(endpoint: string, clientParams?: Record, options?: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.LegacyCallAPIOptions","text":"LegacyCallAPIOptions"}," | undefined) => Promise"],"description":["\nCalls specified `endpoint` with provided `clientParams` on behalf of the\nKibana internal user.\nSee {@link LegacyAPICaller}."],"children":[{"type":"string","label":"endpoint","isRequired":true,"signature":["string"],"description":["- String descriptor of the endpoint e.g. `cluster.getSettings` or `ping`."],"source":{"path":"src/core/server/elasticsearch/legacy/scoped_cluster_client.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L55"}},{"type":"Object","label":"clientParams","isRequired":true,"signature":["Record"],"description":["- A dictionary of parameters that will be passed directly to the Elasticsearch JS client."],"source":{"path":"src/core/server/elasticsearch/legacy/scoped_cluster_client.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L56"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.LegacyCallAPIOptions","text":"LegacyCallAPIOptions"}," | undefined"],"description":["- Options that affect the way we call the API and process the result."],"source":{"path":"src/core/server/elasticsearch/legacy/scoped_cluster_client.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L57"}}],"tags":["deprecated"],"returnComment":[],"source":{"path":"src/core/server/elasticsearch/legacy/scoped_cluster_client.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L54"}},{"id":"def-server.LegacyScopedClusterClient.callAsCurrentUser","type":"Function","label":"callAsCurrentUser","signature":["(endpoint: string, clientParams?: Record, options?: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.LegacyCallAPIOptions","text":"LegacyCallAPIOptions"}," | undefined) => Promise"],"description":["\nCalls specified `endpoint` with provided `clientParams` on behalf of the\nuser initiated request to the Kibana server (via HTTP request headers).\nSee {@link LegacyAPICaller}."],"children":[{"type":"string","label":"endpoint","isRequired":true,"signature":["string"],"description":["- String descriptor of the endpoint e.g. `cluster.getSettings` or `ping`."],"source":{"path":"src/core/server/elasticsearch/legacy/scoped_cluster_client.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L73"}},{"type":"Object","label":"clientParams","isRequired":true,"signature":["Record"],"description":["- A dictionary of parameters that will be passed directly to the Elasticsearch JS client."],"source":{"path":"src/core/server/elasticsearch/legacy/scoped_cluster_client.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L74"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.LegacyCallAPIOptions","text":"LegacyCallAPIOptions"}," | undefined"],"description":["- Options that affect the way we call the API and process the result."],"source":{"path":"src/core/server/elasticsearch/legacy/scoped_cluster_client.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L75"}}],"tags":["deprecated"],"returnComment":[],"source":{"path":"src/core/server/elasticsearch/legacy/scoped_cluster_client.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L72"}}],"source":{"path":"src/core/server/elasticsearch/legacy/scoped_cluster_client.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L34"},"initialIsOpen":false},{"id":"def-server.ElasticsearchConfig","type":"Class","label":"ElasticsearchConfig","description":["\nWrapper of config schema."],"children":[{"id":"def-server.ElasticsearchConfig.healthCheckDelay","type":"Object","label":"healthCheckDelay","description":["\nThe interval between health check requests Kibana sends to the Elasticsearch."],"source":{"path":"src/core/server/elasticsearch/elasticsearch_config.ts","lineNumber":192,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L192"},"signature":["moment.Duration"]},{"id":"def-server.ElasticsearchConfig.ignoreVersionMismatch","type":"boolean","label":"ignoreVersionMismatch","description":["\nWhether to allow kibana to connect to a non-compatible elasticsearch node."],"source":{"path":"src/core/server/elasticsearch/elasticsearch_config.ts","lineNumber":197,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L197"}},{"id":"def-server.ElasticsearchConfig.apiVersion","type":"string","label":"apiVersion","description":["\nVersion of the Elasticsearch (6.7, 7.1 or `master`) client will be connecting to."],"source":{"path":"src/core/server/elasticsearch/elasticsearch_config.ts","lineNumber":202,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L202"}},{"id":"def-server.ElasticsearchConfig.hosts","type":"Array","label":"hosts","description":["\nHosts that the client will connect to. If sniffing is enabled, this list will\nbe used as seeds to discover the rest of your cluster."],"source":{"path":"src/core/server/elasticsearch/elasticsearch_config.ts","lineNumber":208,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L208"},"signature":["string[]"]},{"id":"def-server.ElasticsearchConfig.requestHeadersWhitelist","type":"Array","label":"requestHeadersWhitelist","description":["\nList of Kibana client-side headers to send to Elasticsearch when request\nscoped cluster client is used. If this is an empty array then *no* client-side\nwill be sent."],"source":{"path":"src/core/server/elasticsearch/elasticsearch_config.ts","lineNumber":215,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L215"},"signature":["string[]"]},{"id":"def-server.ElasticsearchConfig.pingTimeout","type":"Object","label":"pingTimeout","description":["\nTimeout after which PING HTTP request will be aborted and retried."],"source":{"path":"src/core/server/elasticsearch/elasticsearch_config.ts","lineNumber":220,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L220"},"signature":["moment.Duration"]},{"id":"def-server.ElasticsearchConfig.requestTimeout","type":"Object","label":"requestTimeout","description":["\nTimeout after which HTTP request will be aborted and retried."],"source":{"path":"src/core/server/elasticsearch/elasticsearch_config.ts","lineNumber":225,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L225"},"signature":["moment.Duration"]},{"id":"def-server.ElasticsearchConfig.shardTimeout","type":"Object","label":"shardTimeout","description":["\nTimeout for Elasticsearch to wait for responses from shards. Set to 0 to disable."],"source":{"path":"src/core/server/elasticsearch/elasticsearch_config.ts","lineNumber":230,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L230"},"signature":["moment.Duration"]},{"id":"def-server.ElasticsearchConfig.sniffOnStart","type":"boolean","label":"sniffOnStart","description":["\nSpecifies whether the client should attempt to detect the rest of the cluster\nwhen it is first instantiated."],"source":{"path":"src/core/server/elasticsearch/elasticsearch_config.ts","lineNumber":236,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L236"}},{"id":"def-server.ElasticsearchConfig.sniffInterval","type":"CompoundType","label":"sniffInterval","description":["\nInterval to perform a sniff operation and make sure the list of nodes is complete.\nIf `false` then sniffing is disabled."],"source":{"path":"src/core/server/elasticsearch/elasticsearch_config.ts","lineNumber":242,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L242"},"signature":["false | moment.Duration"]},{"id":"def-server.ElasticsearchConfig.sniffOnConnectionFault","type":"boolean","label":"sniffOnConnectionFault","description":["\nSpecifies whether the client should immediately sniff for a more current list\nof nodes when a connection dies."],"source":{"path":"src/core/server/elasticsearch/elasticsearch_config.ts","lineNumber":248,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L248"}},{"id":"def-server.ElasticsearchConfig.username","type":"string","label":"username","description":["\nIf Elasticsearch is protected with basic authentication, this setting provides\nthe username that the Kibana server uses to perform its administrative functions."],"source":{"path":"src/core/server/elasticsearch/elasticsearch_config.ts","lineNumber":254,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L254"},"signature":["string | undefined"]},{"id":"def-server.ElasticsearchConfig.password","type":"string","label":"password","description":["\nIf Elasticsearch is protected with basic authentication, this setting provides\nthe password that the Kibana server uses to perform its administrative functions."],"source":{"path":"src/core/server/elasticsearch/elasticsearch_config.ts","lineNumber":260,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L260"},"signature":["string | undefined"]},{"id":"def-server.ElasticsearchConfig.ssl","type":"CompoundType","label":"ssl","description":["\nSet of settings configure SSL connection between Kibana and Elasticsearch that\nare required when `xpack.ssl.verification_mode` in Elasticsearch is set to\neither `certificate` or `full`."],"source":{"path":"src/core/server/elasticsearch/elasticsearch_config.ts","lineNumber":267,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L267"},"signature":["Pick; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"certificate\" | \"verificationMode\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }"]},{"id":"def-server.ElasticsearchConfig.customHeaders","type":"Object","label":"customHeaders","description":["\nHeader names and values to send to Elasticsearch with every request. These\nheaders cannot be overwritten by client-side headers and aren't affected by\n`requestHeadersWhitelist` configuration."],"source":{"path":"src/core/server/elasticsearch/elasticsearch_config.ts","lineNumber":277,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L277"},"signature":["Record"]},{"id":"def-server.ElasticsearchConfig.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"rawConfig","isRequired":true,"signature":["Readonly<{ password?: string | undefined; username?: string | undefined; } & { ssl: Readonly<{ key?: string | undefined; certificate?: string | undefined; certificateAuthorities?: string | string[] | undefined; keyPassphrase?: string | undefined; } & { verificationMode: \"none\" | \"certificate\" | \"full\"; keystore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>; shardTimeout: moment.Duration; requestTimeout: moment.Duration; pingTimeout: moment.Duration; sniffOnStart: boolean; sniffInterval: false | moment.Duration; sniffOnConnectionFault: boolean; hosts: string | string[]; requestHeadersWhitelist: string | string[]; customHeaders: Record; logQueries: boolean; apiVersion: string; healthCheck: Readonly<{} & { delay: moment.Duration; }>; ignoreVersionMismatch: boolean; }>"],"description":[],"source":{"path":"src/core/server/elasticsearch/elasticsearch_config.ts","lineNumber":279,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L279"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/elasticsearch/elasticsearch_config.ts","lineNumber":279,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L279"}}],"source":{"path":"src/core/server/elasticsearch/elasticsearch_config.ts","lineNumber":188,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/elasticsearch_config.ts#L188"},"initialIsOpen":false},{"id":"def-server.LegacyElasticsearchErrorHelpers","type":"Class","label":"LegacyElasticsearchErrorHelpers","description":["\nHelpers for working with errors returned from the Elasticsearch service.Since the internal data of\nerrors are subject to change, consumers of the Elasticsearch service should always use these helpers\nto classify errors instead of checking error internals such as `body.error.header[WWW-Authenticate]`"],"children":[{"id":"def-server.LegacyElasticsearchErrorHelpers.isNotAuthorizedError","type":"Function","label":"isNotAuthorizedError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.LegacyElasticsearchErrorHelpers","text":"LegacyElasticsearchErrorHelpers"},".isNotAuthorizedError"],"description":[],"children":[{"type":"Any","label":"error","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/core/server/elasticsearch/legacy/errors.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/errors.ts#L70"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/elasticsearch/legacy/errors.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/errors.ts#L70"}},{"id":"def-server.LegacyElasticsearchErrorHelpers.decorateNotAuthorizedError","type":"Function","label":"decorateNotAuthorizedError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.LegacyElasticsearchErrorHelpers","text":"LegacyElasticsearchErrorHelpers"},".decorateNotAuthorizedError"],"description":[],"children":[{"type":"Object","label":"error","isRequired":true,"signature":["Error"],"description":[],"source":{"path":"src/core/server/elasticsearch/legacy/errors.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/errors.ts#L74"}},{"type":"string","label":"reason","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"src/core/server/elasticsearch/legacy/errors.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/errors.ts#L74"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/elasticsearch/legacy/errors.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/errors.ts#L74"}}],"source":{"path":"src/core/server/elasticsearch/legacy/errors.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/errors.ts#L69"},"initialIsOpen":false},{"id":"def-server.LogLevel","type":"Class","label":"LogLevel","description":["\nRepresents the log level, manages string to `LogLevel` conversion and comparison of log level\npriorities between themselves."],"signature":["LogLevel"],"children":[{"id":"def-server.LogLevel.id","type":"CompoundType","label":"id","description":[],"source":{"path":"node_modules/@kbn/logging/target/log_level.d.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/log_level.d.ts#L12"},"signature":["LogLevelId"]},{"id":"def-server.LogLevel.value","type":"number","label":"value","description":[],"source":{"path":"node_modules/@kbn/logging/target/log_level.d.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/log_level.d.ts#L13"}},{"id":"def-server.LogLevel.Off","type":"Object","label":"Off","description":[],"source":{"path":"node_modules/@kbn/logging/target/log_level.d.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/log_level.d.ts#L14"},"signature":["LogLevel"]},{"id":"def-server.LogLevel.Fatal","type":"Object","label":"Fatal","description":[],"source":{"path":"node_modules/@kbn/logging/target/log_level.d.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/log_level.d.ts#L15"},"signature":["LogLevel"]},{"id":"def-server.LogLevel.Error","type":"Object","label":"Error","description":[],"source":{"path":"node_modules/@kbn/logging/target/log_level.d.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/log_level.d.ts#L16"},"signature":["LogLevel"]},{"id":"def-server.LogLevel.Warn","type":"Object","label":"Warn","description":[],"source":{"path":"node_modules/@kbn/logging/target/log_level.d.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/log_level.d.ts#L17"},"signature":["LogLevel"]},{"id":"def-server.LogLevel.Info","type":"Object","label":"Info","description":[],"source":{"path":"node_modules/@kbn/logging/target/log_level.d.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/log_level.d.ts#L18"},"signature":["LogLevel"]},{"id":"def-server.LogLevel.Debug","type":"Object","label":"Debug","description":[],"source":{"path":"node_modules/@kbn/logging/target/log_level.d.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/log_level.d.ts#L19"},"signature":["LogLevel"]},{"id":"def-server.LogLevel.Trace","type":"Object","label":"Trace","description":[],"source":{"path":"node_modules/@kbn/logging/target/log_level.d.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/log_level.d.ts#L20"},"signature":["LogLevel"]},{"id":"def-server.LogLevel.All","type":"Object","label":"All","description":[],"source":{"path":"node_modules/@kbn/logging/target/log_level.d.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/log_level.d.ts#L21"},"signature":["LogLevel"]},{"id":"def-server.LogLevel.fromId","type":"Function","label":"fromId","signature":["typeof ","LogLevel",".fromId"],"description":["\nConverts string representation of log level into `LogLevel` instance."],"children":[{"type":"CompoundType","label":"level","isRequired":true,"signature":["LogLevelId"],"description":["- String representation of log level."],"source":{"path":"node_modules/@kbn/logging/target/log_level.d.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/log_level.d.ts#L27"}}],"tags":[],"returnComment":["Instance of `LogLevel` class."],"source":{"path":"node_modules/@kbn/logging/target/log_level.d.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/log_level.d.ts#L27"}},{"id":"def-server.LogLevel.supports","type":"Function","label":"supports","signature":["(level: ","LogLevel",") => boolean"],"description":["\nIndicates whether current log level covers the one that is passed as an argument."],"children":[{"type":"Object","label":"level","isRequired":true,"signature":["LogLevel"],"description":["- Instance of `LogLevel` to compare to."],"source":{"path":"node_modules/@kbn/logging/target/log_level.d.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/log_level.d.ts#L34"}}],"tags":[],"returnComment":["True if specified `level` is covered by this log level."],"source":{"path":"node_modules/@kbn/logging/target/log_level.d.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/log_level.d.ts#L34"}}],"source":{"path":"node_modules/@kbn/logging/target/log_level.d.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/log_level.d.ts#L11"},"initialIsOpen":false}],"functions":[],"interfaces":[{"id":"def-server.CoreUsageStats","type":"Interface","label":"CoreUsageStats","description":[],"children":[{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsBulkCreate.total'","type":"number","label":"'apiCalls.savedObjectsBulkCreate.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L20"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsBulkCreate.namespace.default.total'","type":"number","label":"'apiCalls.savedObjectsBulkCreate.namespace.default.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L21"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsBulkCreate.namespace.default.kibanaRequest.yes'","type":"number","label":"'apiCalls.savedObjectsBulkCreate.namespace.default.kibanaRequest.yes'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L22"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsBulkCreate.namespace.default.kibanaRequest.no'","type":"number","label":"'apiCalls.savedObjectsBulkCreate.namespace.default.kibanaRequest.no'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L23"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsBulkCreate.namespace.custom.total'","type":"number","label":"'apiCalls.savedObjectsBulkCreate.namespace.custom.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L24"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsBulkCreate.namespace.custom.kibanaRequest.yes'","type":"number","label":"'apiCalls.savedObjectsBulkCreate.namespace.custom.kibanaRequest.yes'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L25"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsBulkCreate.namespace.custom.kibanaRequest.no'","type":"number","label":"'apiCalls.savedObjectsBulkCreate.namespace.custom.kibanaRequest.no'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L26"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsBulkGet.total'","type":"number","label":"'apiCalls.savedObjectsBulkGet.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L27"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsBulkGet.namespace.default.total'","type":"number","label":"'apiCalls.savedObjectsBulkGet.namespace.default.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L28"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsBulkGet.namespace.default.kibanaRequest.yes'","type":"number","label":"'apiCalls.savedObjectsBulkGet.namespace.default.kibanaRequest.yes'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L29"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsBulkGet.namespace.default.kibanaRequest.no'","type":"number","label":"'apiCalls.savedObjectsBulkGet.namespace.default.kibanaRequest.no'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L30"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsBulkGet.namespace.custom.total'","type":"number","label":"'apiCalls.savedObjectsBulkGet.namespace.custom.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L31"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsBulkGet.namespace.custom.kibanaRequest.yes'","type":"number","label":"'apiCalls.savedObjectsBulkGet.namespace.custom.kibanaRequest.yes'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L32"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsBulkGet.namespace.custom.kibanaRequest.no'","type":"number","label":"'apiCalls.savedObjectsBulkGet.namespace.custom.kibanaRequest.no'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L33"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsBulkUpdate.total'","type":"number","label":"'apiCalls.savedObjectsBulkUpdate.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L34"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsBulkUpdate.namespace.default.total'","type":"number","label":"'apiCalls.savedObjectsBulkUpdate.namespace.default.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L35"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsBulkUpdate.namespace.default.kibanaRequest.yes'","type":"number","label":"'apiCalls.savedObjectsBulkUpdate.namespace.default.kibanaRequest.yes'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L36"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsBulkUpdate.namespace.default.kibanaRequest.no'","type":"number","label":"'apiCalls.savedObjectsBulkUpdate.namespace.default.kibanaRequest.no'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L37"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsBulkUpdate.namespace.custom.total'","type":"number","label":"'apiCalls.savedObjectsBulkUpdate.namespace.custom.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L38"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsBulkUpdate.namespace.custom.kibanaRequest.yes'","type":"number","label":"'apiCalls.savedObjectsBulkUpdate.namespace.custom.kibanaRequest.yes'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L39"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsBulkUpdate.namespace.custom.kibanaRequest.no'","type":"number","label":"'apiCalls.savedObjectsBulkUpdate.namespace.custom.kibanaRequest.no'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L40"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsCreate.total'","type":"number","label":"'apiCalls.savedObjectsCreate.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L41"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsCreate.namespace.default.total'","type":"number","label":"'apiCalls.savedObjectsCreate.namespace.default.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L42"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsCreate.namespace.default.kibanaRequest.yes'","type":"number","label":"'apiCalls.savedObjectsCreate.namespace.default.kibanaRequest.yes'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L43"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsCreate.namespace.default.kibanaRequest.no'","type":"number","label":"'apiCalls.savedObjectsCreate.namespace.default.kibanaRequest.no'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L44"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsCreate.namespace.custom.total'","type":"number","label":"'apiCalls.savedObjectsCreate.namespace.custom.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L45"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsCreate.namespace.custom.kibanaRequest.yes'","type":"number","label":"'apiCalls.savedObjectsCreate.namespace.custom.kibanaRequest.yes'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L46"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsCreate.namespace.custom.kibanaRequest.no'","type":"number","label":"'apiCalls.savedObjectsCreate.namespace.custom.kibanaRequest.no'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L47"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsDelete.total'","type":"number","label":"'apiCalls.savedObjectsDelete.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L48"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsDelete.namespace.default.total'","type":"number","label":"'apiCalls.savedObjectsDelete.namespace.default.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L49"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsDelete.namespace.default.kibanaRequest.yes'","type":"number","label":"'apiCalls.savedObjectsDelete.namespace.default.kibanaRequest.yes'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L50"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsDelete.namespace.default.kibanaRequest.no'","type":"number","label":"'apiCalls.savedObjectsDelete.namespace.default.kibanaRequest.no'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L51"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsDelete.namespace.custom.total'","type":"number","label":"'apiCalls.savedObjectsDelete.namespace.custom.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L52"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsDelete.namespace.custom.kibanaRequest.yes'","type":"number","label":"'apiCalls.savedObjectsDelete.namespace.custom.kibanaRequest.yes'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L53"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsDelete.namespace.custom.kibanaRequest.no'","type":"number","label":"'apiCalls.savedObjectsDelete.namespace.custom.kibanaRequest.no'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L54"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsFind.total'","type":"number","label":"'apiCalls.savedObjectsFind.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L55"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsFind.namespace.default.total'","type":"number","label":"'apiCalls.savedObjectsFind.namespace.default.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L56"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsFind.namespace.default.kibanaRequest.yes'","type":"number","label":"'apiCalls.savedObjectsFind.namespace.default.kibanaRequest.yes'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L57"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsFind.namespace.default.kibanaRequest.no'","type":"number","label":"'apiCalls.savedObjectsFind.namespace.default.kibanaRequest.no'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L58"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsFind.namespace.custom.total'","type":"number","label":"'apiCalls.savedObjectsFind.namespace.custom.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L59"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsFind.namespace.custom.kibanaRequest.yes'","type":"number","label":"'apiCalls.savedObjectsFind.namespace.custom.kibanaRequest.yes'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L60"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsFind.namespace.custom.kibanaRequest.no'","type":"number","label":"'apiCalls.savedObjectsFind.namespace.custom.kibanaRequest.no'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L61"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsGet.total'","type":"number","label":"'apiCalls.savedObjectsGet.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L62"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsGet.namespace.default.total'","type":"number","label":"'apiCalls.savedObjectsGet.namespace.default.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L63"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsGet.namespace.default.kibanaRequest.yes'","type":"number","label":"'apiCalls.savedObjectsGet.namespace.default.kibanaRequest.yes'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L64"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsGet.namespace.default.kibanaRequest.no'","type":"number","label":"'apiCalls.savedObjectsGet.namespace.default.kibanaRequest.no'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L65"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsGet.namespace.custom.total'","type":"number","label":"'apiCalls.savedObjectsGet.namespace.custom.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L66"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsGet.namespace.custom.kibanaRequest.yes'","type":"number","label":"'apiCalls.savedObjectsGet.namespace.custom.kibanaRequest.yes'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L67"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsGet.namespace.custom.kibanaRequest.no'","type":"number","label":"'apiCalls.savedObjectsGet.namespace.custom.kibanaRequest.no'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L68"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsResolve.total'","type":"number","label":"'apiCalls.savedObjectsResolve.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L69"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsResolve.namespace.default.total'","type":"number","label":"'apiCalls.savedObjectsResolve.namespace.default.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L70"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsResolve.namespace.default.kibanaRequest.yes'","type":"number","label":"'apiCalls.savedObjectsResolve.namespace.default.kibanaRequest.yes'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L71"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsResolve.namespace.default.kibanaRequest.no'","type":"number","label":"'apiCalls.savedObjectsResolve.namespace.default.kibanaRequest.no'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L72"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsResolve.namespace.custom.total'","type":"number","label":"'apiCalls.savedObjectsResolve.namespace.custom.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L73"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsResolve.namespace.custom.kibanaRequest.yes'","type":"number","label":"'apiCalls.savedObjectsResolve.namespace.custom.kibanaRequest.yes'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L74"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsResolve.namespace.custom.kibanaRequest.no'","type":"number","label":"'apiCalls.savedObjectsResolve.namespace.custom.kibanaRequest.no'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L75"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsUpdate.total'","type":"number","label":"'apiCalls.savedObjectsUpdate.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":76,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L76"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsUpdate.namespace.default.total'","type":"number","label":"'apiCalls.savedObjectsUpdate.namespace.default.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L77"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsUpdate.namespace.default.kibanaRequest.yes'","type":"number","label":"'apiCalls.savedObjectsUpdate.namespace.default.kibanaRequest.yes'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L78"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsUpdate.namespace.default.kibanaRequest.no'","type":"number","label":"'apiCalls.savedObjectsUpdate.namespace.default.kibanaRequest.no'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L79"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsUpdate.namespace.custom.total'","type":"number","label":"'apiCalls.savedObjectsUpdate.namespace.custom.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L80"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsUpdate.namespace.custom.kibanaRequest.yes'","type":"number","label":"'apiCalls.savedObjectsUpdate.namespace.custom.kibanaRequest.yes'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L81"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsUpdate.namespace.custom.kibanaRequest.no'","type":"number","label":"'apiCalls.savedObjectsUpdate.namespace.custom.kibanaRequest.no'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L82"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsImport.total'","type":"number","label":"'apiCalls.savedObjectsImport.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L84"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsImport.namespace.default.total'","type":"number","label":"'apiCalls.savedObjectsImport.namespace.default.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":85,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L85"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsImport.namespace.default.kibanaRequest.yes'","type":"number","label":"'apiCalls.savedObjectsImport.namespace.default.kibanaRequest.yes'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L86"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsImport.namespace.default.kibanaRequest.no'","type":"number","label":"'apiCalls.savedObjectsImport.namespace.default.kibanaRequest.no'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":87,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L87"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsImport.namespace.custom.total'","type":"number","label":"'apiCalls.savedObjectsImport.namespace.custom.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L88"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsImport.namespace.custom.kibanaRequest.yes'","type":"number","label":"'apiCalls.savedObjectsImport.namespace.custom.kibanaRequest.yes'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L89"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsImport.namespace.custom.kibanaRequest.no'","type":"number","label":"'apiCalls.savedObjectsImport.namespace.custom.kibanaRequest.no'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L90"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsImport.createNewCopiesEnabled.yes'","type":"number","label":"'apiCalls.savedObjectsImport.createNewCopiesEnabled.yes'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":91,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L91"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsImport.createNewCopiesEnabled.no'","type":"number","label":"'apiCalls.savedObjectsImport.createNewCopiesEnabled.no'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L92"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsImport.overwriteEnabled.yes'","type":"number","label":"'apiCalls.savedObjectsImport.overwriteEnabled.yes'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":93,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L93"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsImport.overwriteEnabled.no'","type":"number","label":"'apiCalls.savedObjectsImport.overwriteEnabled.no'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L94"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsResolveImportErrors.total'","type":"number","label":"'apiCalls.savedObjectsResolveImportErrors.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L95"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsResolveImportErrors.namespace.default.total'","type":"number","label":"'apiCalls.savedObjectsResolveImportErrors.namespace.default.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L96"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsResolveImportErrors.namespace.default.kibanaRequest.yes'","type":"number","label":"'apiCalls.savedObjectsResolveImportErrors.namespace.default.kibanaRequest.yes'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L97"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsResolveImportErrors.namespace.default.kibanaRequest.no'","type":"number","label":"'apiCalls.savedObjectsResolveImportErrors.namespace.default.kibanaRequest.no'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L98"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsResolveImportErrors.namespace.custom.total'","type":"number","label":"'apiCalls.savedObjectsResolveImportErrors.namespace.custom.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L99"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsResolveImportErrors.namespace.custom.kibanaRequest.yes'","type":"number","label":"'apiCalls.savedObjectsResolveImportErrors.namespace.custom.kibanaRequest.yes'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":100,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L100"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsResolveImportErrors.namespace.custom.kibanaRequest.no'","type":"number","label":"'apiCalls.savedObjectsResolveImportErrors.namespace.custom.kibanaRequest.no'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L101"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsResolveImportErrors.createNewCopiesEnabled.yes'","type":"number","label":"'apiCalls.savedObjectsResolveImportErrors.createNewCopiesEnabled.yes'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L102"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsResolveImportErrors.createNewCopiesEnabled.no'","type":"number","label":"'apiCalls.savedObjectsResolveImportErrors.createNewCopiesEnabled.no'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L103"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsExport.total'","type":"number","label":"'apiCalls.savedObjectsExport.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L104"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsExport.namespace.default.total'","type":"number","label":"'apiCalls.savedObjectsExport.namespace.default.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":105,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L105"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsExport.namespace.default.kibanaRequest.yes'","type":"number","label":"'apiCalls.savedObjectsExport.namespace.default.kibanaRequest.yes'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":106,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L106"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsExport.namespace.default.kibanaRequest.no'","type":"number","label":"'apiCalls.savedObjectsExport.namespace.default.kibanaRequest.no'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":107,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L107"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsExport.namespace.custom.total'","type":"number","label":"'apiCalls.savedObjectsExport.namespace.custom.total'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L108"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsExport.namespace.custom.kibanaRequest.yes'","type":"number","label":"'apiCalls.savedObjectsExport.namespace.custom.kibanaRequest.yes'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":109,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L109"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsExport.namespace.custom.kibanaRequest.no'","type":"number","label":"'apiCalls.savedObjectsExport.namespace.custom.kibanaRequest.no'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L110"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsExport.allTypesSelected.yes'","type":"number","label":"'apiCalls.savedObjectsExport.allTypesSelected.yes'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":111,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L111"},"signature":["number | undefined"]},{"id":"def-server.CoreUsageStats.'apiCalls.savedObjectsExport.allTypesSelected.no'","type":"number","label":"'apiCalls.savedObjectsExport.allTypesSelected.no'","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":112,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L112"},"signature":["number | undefined"]}],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L18"},"initialIsOpen":false},{"id":"def-server.CoreUsageData","type":"Interface","label":"CoreUsageData","signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreUsageData","text":"CoreUsageData"}," extends ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreUsageStats","text":"CoreUsageStats"}],"description":["\nType describing Core's usage data payload"],"children":[{"id":"def-server.CoreUsageData.config","type":"Object","label":"config","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":120,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L120"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreConfigUsageData","text":"CoreConfigUsageData"}]},{"id":"def-server.CoreUsageData.services","type":"Object","label":"services","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":121,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L121"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreServicesUsageData","text":"CoreServicesUsageData"}]},{"id":"def-server.CoreUsageData.environment","type":"Object","label":"environment","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":122,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L122"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreEnvironmentUsageData","text":"CoreEnvironmentUsageData"}]}],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":119,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L119"},"initialIsOpen":false},{"id":"def-server.CoreConfigUsageData","type":"Interface","label":"CoreConfigUsageData","description":["\nUsage data on this cluster's configuration of Core features"],"children":[{"id":"def-server.CoreConfigUsageData.elasticsearch","type":"Object","label":"elasticsearch","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":162,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L162"},"signature":["{ sniffOnStart: boolean; sniffIntervalMs?: number | undefined; sniffOnConnectionFault: boolean; numberOfHostsConfigured: number; requestHeadersWhitelistConfigured: boolean; customHeadersConfigured: boolean; shardTimeoutMs: number; requestTimeoutMs: number; pingTimeoutMs: number; logQueries: boolean; ssl: { verificationMode: \"none\" | \"certificate\" | \"full\"; certificateAuthoritiesConfigured: boolean; certificateConfigured: boolean; keyConfigured: boolean; keystoreConfigured: boolean; truststoreConfigured: boolean; alwaysPresentCertificate: boolean; }; apiVersion: string; healthCheckDelayMs: number; }"]},{"id":"def-server.CoreConfigUsageData.http","type":"Object","label":"http","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":186,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L186"},"signature":["{ basePathConfigured: boolean; maxPayloadInBytes: number; rewriteBasePath: boolean; keepaliveTimeout: number; socketTimeout: number; compression: { enabled: boolean; referrerWhitelistConfigured: boolean; }; xsrf: { disableProtection: boolean; allowlistConfigured: boolean; }; requestId: { allowFromAnyIp: boolean; ipAllowlistConfigured: boolean; }; ssl: { certificateAuthoritiesConfigured: boolean; certificateConfigured: boolean; cipherSuites: string[]; keyConfigured: boolean; keystoreConfigured: boolean; truststoreConfigured: boolean; redirectHttpFromPortConfigured: boolean; supportedProtocols: string[]; clientAuthentication: \"required\" | \"none\" | \"optional\"; }; }"]},{"id":"def-server.CoreConfigUsageData.logging","type":"Object","label":"logging","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":217,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L217"},"signature":["{ appendersTypesUsed: string[]; loggersConfiguredCount: number; }"]},{"id":"def-server.CoreConfigUsageData.savedObjects","type":"Object","label":"savedObjects","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":229,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L229"},"signature":["{ customIndex: boolean; maxImportPayloadBytes: number; maxImportExportSizeBytes: number; }"]}],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":161,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L161"},"initialIsOpen":false},{"id":"def-server.CoreEnvironmentUsageData","type":"Interface","label":"CoreEnvironmentUsageData","description":["\nUsage data on this Kibana node's runtime environment."],"children":[{"id":"def-server.CoreEnvironmentUsageData.memory","type":"Object","label":"memory","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":149,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L149"},"signature":["{ heapTotalBytes: number; heapUsedBytes: number; heapSizeLimit: number; }"]}],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":148,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L148"},"initialIsOpen":false},{"id":"def-server.CoreServicesUsageData","type":"Interface","label":"CoreServicesUsageData","description":["\nUsage data from Core services"],"children":[{"id":"def-server.CoreServicesUsageData.savedObjects","type":"Object","label":"savedObjects","description":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":130,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L130"},"signature":["{ indices: { alias: string; docsCount: number; docsDeleted: number; storeSizeBytes: number; primaryStoreSizeBytes: number; }[]; }"]}],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":129,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L129"},"initialIsOpen":false},{"id":"def-server.Capabilities","type":"Interface","label":"Capabilities","description":["\nThe read-only set of capabilities available for the current UI session.\nCapabilities are simple key-value pairs of (string, boolean), where the string denotes the capability ID,\nand the boolean is a flag indicating if the capability is enabled or disabled.\n"],"children":[{"id":"def-server.Capabilities.navLinks","type":"Object","label":"navLinks","description":["Navigation link capabilities."],"source":{"path":"src/core/types/capabilities.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/capabilities.ts#L18"},"signature":["Record"]},{"id":"def-server.Capabilities.management","type":"Object","label":"management","description":["Management section capabilities."],"source":{"path":"src/core/types/capabilities.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/capabilities.ts#L21"},"signature":["{ [sectionId: string]: Record; }"]},{"id":"def-server.Capabilities.catalogue","type":"Object","label":"catalogue","description":["Catalogue capabilities. Catalogue entries drive the visibility of the Kibana homepage options."],"source":{"path":"src/core/types/capabilities.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/capabilities.ts#L26"},"signature":["Record"]},{"id":"def-server.Capabilities.Unnamed","type":"Any","label":"Unnamed","description":["Custom capabilities, registered by plugins."],"source":{"path":"src/core/types/capabilities.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/capabilities.ts#L29"},"signature":["any"]}],"source":{"path":"src/core/types/capabilities.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/capabilities.ts#L16"},"initialIsOpen":false},{"id":"def-server.ResolveCapabilitiesOptions","type":"Interface","label":"ResolveCapabilitiesOptions","description":["\nDefines a set of additional options for the `resolveCapabilities` method of {@link CapabilitiesStart}.\n"],"children":[{"id":"def-server.ResolveCapabilitiesOptions.useDefaultCapabilities","type":"boolean","label":"useDefaultCapabilities","description":["\nIndicates if capability switchers are supposed to return a default set of capabilities."],"source":{"path":"src/core/server/capabilities/capabilities_service.ts","lineNumber":105,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L105"}}],"source":{"path":"src/core/server/capabilities/capabilities_service.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L101"},"initialIsOpen":false},{"id":"def-server.ConfigDeprecationFactory","type":"Interface","label":"ConfigDeprecationFactory","signature":["ConfigDeprecationFactory"],"description":["\nProvides helpers to generates the most commonly used {@link ConfigDeprecation}\nwhen invoking a {@link ConfigDeprecationProvider}.\n\nSee methods documentation for more detailed examples.\n"],"children":[{"id":"def-server.ConfigDeprecationFactory.rename","type":"Function","label":"rename","signature":["(oldKey: string, newKey: string) => ","ConfigDeprecation"],"description":["\nRename a configuration property from inside a plugin's configuration path.\nWill log a deprecation warning if the oldKey was found and deprecation applied.\n"],"children":[{"type":"string","label":"oldKey","isRequired":true,"signature":["string"],"description":[],"source":{"path":"node_modules/@kbn/config/target/deprecation/types.d.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/deprecation/types.d.ts#L63"}},{"type":"string","label":"newKey","isRequired":true,"signature":["string"],"description":[],"source":{"path":"node_modules/@kbn/config/target/deprecation/types.d.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/deprecation/types.d.ts#L63"}}],"tags":["example"],"returnComment":[],"source":{"path":"node_modules/@kbn/config/target/deprecation/types.d.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/deprecation/types.d.ts#L63"}},{"id":"def-server.ConfigDeprecationFactory.renameFromRoot","type":"Function","label":"renameFromRoot","signature":["(oldKey: string, newKey: string, silent?: boolean | undefined) => ","ConfigDeprecation"],"description":["\nRename a configuration property from the root configuration.\nWill log a deprecation warning if the oldKey was found and deprecation applied.\n\nThis should be only used when renaming properties from different configuration's path.\nTo rename properties from inside a plugin's configuration, use 'rename' instead.\n"],"children":[{"type":"string","label":"oldKey","isRequired":true,"signature":["string"],"description":[],"source":{"path":"node_modules/@kbn/config/target/deprecation/types.d.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/deprecation/types.d.ts#L79"}},{"type":"string","label":"newKey","isRequired":true,"signature":["string"],"description":[],"source":{"path":"node_modules/@kbn/config/target/deprecation/types.d.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/deprecation/types.d.ts#L79"}},{"type":"CompoundType","label":"silent","isRequired":false,"signature":["boolean | undefined"],"description":[],"source":{"path":"node_modules/@kbn/config/target/deprecation/types.d.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/deprecation/types.d.ts#L79"}}],"tags":["example"],"returnComment":[],"source":{"path":"node_modules/@kbn/config/target/deprecation/types.d.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/deprecation/types.d.ts#L79"}},{"id":"def-server.ConfigDeprecationFactory.unused","type":"Function","label":"unused","signature":["(unusedKey: string) => ","ConfigDeprecation"],"description":["\nRemove a configuration property from inside a plugin's configuration path.\nWill log a deprecation warning if the unused key was found and deprecation applied.\n"],"children":[{"type":"string","label":"unusedKey","isRequired":true,"signature":["string"],"description":[],"source":{"path":"node_modules/@kbn/config/target/deprecation/types.d.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/deprecation/types.d.ts#L92"}}],"tags":["example"],"returnComment":[],"source":{"path":"node_modules/@kbn/config/target/deprecation/types.d.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/deprecation/types.d.ts#L92"}},{"id":"def-server.ConfigDeprecationFactory.unusedFromRoot","type":"Function","label":"unusedFromRoot","signature":["(unusedKey: string) => ","ConfigDeprecation"],"description":["\nRemove a configuration property from the root configuration.\nWill log a deprecation warning if the unused key was found and deprecation applied.\n\nThis should be only used when removing properties from outside of a plugin's configuration.\nTo remove properties from inside a plugin's configuration, use 'unused' instead.\n"],"children":[{"type":"string","label":"unusedKey","isRequired":true,"signature":["string"],"description":[],"source":{"path":"node_modules/@kbn/config/target/deprecation/types.d.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/deprecation/types.d.ts#L108"}}],"tags":["example"],"returnComment":[],"source":{"path":"node_modules/@kbn/config/target/deprecation/types.d.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/deprecation/types.d.ts#L108"}}],"source":{"path":"node_modules/@kbn/config/target/deprecation/types.d.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/deprecation/types.d.ts#L50"},"initialIsOpen":false},{"id":"def-server.EnvironmentMode","type":"Interface","label":"EnvironmentMode","signature":["EnvironmentMode"],"description":[],"children":[{"id":"def-server.EnvironmentMode.name","type":"CompoundType","label":"name","description":[],"source":{"path":"node_modules/@kbn/config/target/types.d.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L15"},"signature":["\"production\" | \"development\""]},{"id":"def-server.EnvironmentMode.dev","type":"boolean","label":"dev","description":[],"source":{"path":"node_modules/@kbn/config/target/types.d.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L16"}},{"id":"def-server.EnvironmentMode.prod","type":"boolean","label":"prod","description":[],"source":{"path":"node_modules/@kbn/config/target/types.d.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L17"}}],"source":{"path":"node_modules/@kbn/config/target/types.d.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L14"},"initialIsOpen":false},{"id":"def-server.PackageInfo","type":"Interface","label":"PackageInfo","signature":["PackageInfo"],"description":[],"children":[{"id":"def-server.PackageInfo.version","type":"string","label":"version","description":[],"source":{"path":"node_modules/@kbn/config/target/types.d.ts","lineNumber":5,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L5"}},{"id":"def-server.PackageInfo.branch","type":"string","label":"branch","description":[],"source":{"path":"node_modules/@kbn/config/target/types.d.ts","lineNumber":6,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L6"}},{"id":"def-server.PackageInfo.buildNum","type":"number","label":"buildNum","description":[],"source":{"path":"node_modules/@kbn/config/target/types.d.ts","lineNumber":7,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L7"}},{"id":"def-server.PackageInfo.buildSha","type":"string","label":"buildSha","description":[],"source":{"path":"node_modules/@kbn/config/target/types.d.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L8"}},{"id":"def-server.PackageInfo.dist","type":"boolean","label":"dist","description":[],"source":{"path":"node_modules/@kbn/config/target/types.d.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L9"}}],"source":{"path":"node_modules/@kbn/config/target/types.d.ts","lineNumber":4,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/types.d.ts#L4"},"initialIsOpen":false},{"id":"def-server.IContextContainer","type":"Interface","label":"IContextContainer","signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.IContextContainer","text":"IContextContainer"},""],"description":["\nAn object that handles registration of context providers and configuring handlers with context.\n"],"children":[{"id":"def-server.IContextContainer.registerContext","type":"Function","label":"registerContext","signature":["(pluginOpaqueId: symbol, contextName: ContextName, provider: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.IContextProvider","text":"IContextProvider"},") => this"],"description":["\nRegister a new context provider.\n"],"children":[{"type":"Uncategorized","label":"pluginOpaqueId","isRequired":true,"signature":["symbol"],"description":["- The plugin opaque ID for the plugin that registers this context."],"source":{"path":"src/core/server/context/container/context.ts","lineNumber":154,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/context/container/context.ts#L154"}},{"type":"Uncategorized","label":"contextName","isRequired":true,"signature":["ContextName"],"description":["- The key of the `TContext` object this provider supplies the value for."],"source":{"path":"src/core/server/context/container/context.ts","lineNumber":155,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/context/container/context.ts#L155"}},{"type":"Function","label":"provider","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.IContextProvider","text":"IContextProvider"},""],"description":["- A {@link IContextProvider} to be called each time a new context is created."],"source":{"path":"src/core/server/context/container/context.ts","lineNumber":156,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/context/container/context.ts#L156"}}],"tags":["remarks"],"returnComment":["The {@link IContextContainer} for method chaining."],"source":{"path":"src/core/server/context/container/context.ts","lineNumber":153,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/context/container/context.ts#L153"}},{"id":"def-server.IContextContainer.createHandler","type":"Function","label":"createHandler","signature":["(pluginOpaqueId: symbol, handler: THandler) => (...rest: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.HandlerParameters","text":"HandlerParameters"},") => ","ShallowPromise",">"],"description":["\nCreate a new handler function pre-wired to context for the plugin.\n"],"children":[{"type":"Uncategorized","label":"pluginOpaqueId","isRequired":true,"signature":["symbol"],"description":["- The plugin opaque ID for the plugin that registers this handler."],"source":{"path":"src/core/server/context/container/context.ts","lineNumber":168,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/context/container/context.ts#L168"}},{"type":"Function","label":"handler","isRequired":true,"signature":["THandler"],"description":["- Handler function to pass context object to."],"source":{"path":"src/core/server/context/container/context.ts","lineNumber":169,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/context/container/context.ts#L169"}}],"tags":[],"returnComment":["A function that takes `THandlerParameters`, calls `handler` with a new context, and returns a Promise of\nthe `handler` return value."],"source":{"path":"src/core/server/context/container/context.ts","lineNumber":167,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/context/container/context.ts#L167"}}],"source":{"path":"src/core/server/context/container/context.ts","lineNumber":138,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/context/container/context.ts#L138"},"initialIsOpen":false},{"id":"def-server.ICspConfig","type":"Interface","label":"ICspConfig","description":["\nCSP configuration for use in Kibana."],"children":[{"id":"def-server.ICspConfig.rules","type":"Array","label":"rules","description":["\nThe CSP rules used for Kibana."],"source":{"path":"src/core/server/csp/csp_config.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/csp/csp_config.ts#L21"},"signature":["string[]"]},{"id":"def-server.ICspConfig.strict","type":"boolean","label":"strict","description":["\nSpecify whether browsers that do not support CSP should be\nable to use Kibana. Use `true` to block and `false` to allow."],"source":{"path":"src/core/server/csp/csp_config.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/csp/csp_config.ts#L27"}},{"id":"def-server.ICspConfig.warnLegacyBrowsers","type":"boolean","label":"warnLegacyBrowsers","description":["\nSpecify whether users with legacy browsers should be warned\nabout their lack of Kibana security compliance."],"source":{"path":"src/core/server/csp/csp_config.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/csp/csp_config.ts#L33"}},{"id":"def-server.ICspConfig.header","type":"string","label":"header","description":["\nThe CSP rules in a formatted directives string for use\nin a `Content-Security-Policy` header."],"source":{"path":"src/core/server/csp/csp_config.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/csp/csp_config.ts#L39"}}],"source":{"path":"src/core/server/csp/csp_config.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/csp/csp_config.ts#L17"},"initialIsOpen":false},{"id":"def-server.LegacyElasticsearchError","type":"Interface","label":"LegacyElasticsearchError","signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.LegacyElasticsearchError","text":"LegacyElasticsearchError"}," extends ","Boom",""],"description":[],"children":[{"id":"def-server.LegacyElasticsearchError.[code]","type":"string","label":"[code]","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/errors.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/errors.ts#L23"},"signature":["string | undefined"]}],"source":{"path":"src/core/server/elasticsearch/legacy/errors.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/errors.ts#L22"},"initialIsOpen":false},{"id":"def-server.ElasticsearchServiceSetup","type":"Interface","label":"ElasticsearchServiceSetup","description":[],"children":[{"id":"def-server.ElasticsearchServiceSetup.legacy","type":"Object","label":"legacy","description":[],"source":{"path":"src/core/server/elasticsearch/types.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/types.ts#L30"},"signature":["{ readonly config$: ","Observable","<",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ElasticsearchConfig","text":"ElasticsearchConfig"},">; readonly createClient: (type: string, clientConfig?: Partial<",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.LegacyElasticsearchClientConfig","text":"LegacyElasticsearchClientConfig"},"> | undefined) => Pick<",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.LegacyClusterClient","text":"LegacyClusterClient"},", \"close\" | \"callAsInternalUser\" | \"asScoped\">; readonly client: Pick<",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.LegacyClusterClient","text":"LegacyClusterClient"}]}],"source":{"path":"src/core/server/elasticsearch/types.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/types.ts#L25"},"initialIsOpen":false},{"id":"def-server.ElasticsearchServiceStart","type":"Interface","label":"ElasticsearchServiceStart","description":[],"children":[{"id":"def-server.ElasticsearchServiceStart.client","type":"Object","label":"client","description":["\nA pre-configured {@link IClusterClient | Elasticsearch client}\n"],"source":{"path":"src/core/server/elasticsearch/types.ts","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/types.ts#L96"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.IClusterClient","text":"IClusterClient"}]},{"id":"def-server.ElasticsearchServiceStart.createClient","type":"Function","label":"createClient","description":["\nCreate application specific Elasticsearch cluster API client with customized config. See {@link IClusterClient}.\n"],"source":{"path":"src/core/server/elasticsearch/types.ts","lineNumber":114,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/types.ts#L114"},"signature":["(type: string, clientConfig?: Partial<",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ElasticsearchClientConfig","text":"ElasticsearchClientConfig"},"> | undefined) => ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ICustomClusterClient","text":"ICustomClusterClient"}]},{"id":"def-server.ElasticsearchServiceStart.legacy","type":"Object","label":"legacy","description":[],"source":{"path":"src/core/server/elasticsearch/types.ts","lineNumber":124,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/types.ts#L124"},"signature":["{ readonly config$: ","Observable","<",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ElasticsearchConfig","text":"ElasticsearchConfig"},">; readonly createClient: (type: string, clientConfig?: Partial<",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.LegacyElasticsearchClientConfig","text":"LegacyElasticsearchClientConfig"},"> | undefined) => Pick<",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.LegacyClusterClient","text":"LegacyClusterClient"},", \"close\" | \"callAsInternalUser\" | \"asScoped\">; readonly client: Pick<",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.LegacyClusterClient","text":"LegacyClusterClient"}]}],"source":{"path":"src/core/server/elasticsearch/types.ts","lineNumber":87,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/types.ts#L87"},"initialIsOpen":false},{"id":"def-server.ElasticsearchStatusMeta","type":"Interface","label":"ElasticsearchStatusMeta","description":[],"children":[{"id":"def-server.ElasticsearchStatusMeta.warningNodes","type":"Array","label":"warningNodes","description":[],"source":{"path":"src/core/server/elasticsearch/types.ts","lineNumber":172,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/types.ts#L172"},"signature":["NodeInfo[]"]},{"id":"def-server.ElasticsearchStatusMeta.incompatibleNodes","type":"Array","label":"incompatibleNodes","description":[],"source":{"path":"src/core/server/elasticsearch/types.ts","lineNumber":173,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/types.ts#L173"},"signature":["NodeInfo[]"]}],"source":{"path":"src/core/server/elasticsearch/types.ts","lineNumber":171,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/types.ts#L171"},"initialIsOpen":false},{"id":"def-server.NodesVersionCompatibility","type":"Interface","label":"NodesVersionCompatibility","description":[],"children":[{"id":"def-server.NodesVersionCompatibility.isCompatible","type":"boolean","label":"isCompatible","description":[],"source":{"path":"src/core/server/elasticsearch/version_check/ensure_es_version.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/version_check/ensure_es_version.ts#L47"}},{"id":"def-server.NodesVersionCompatibility.message","type":"string","label":"message","description":[],"source":{"path":"src/core/server/elasticsearch/version_check/ensure_es_version.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/version_check/ensure_es_version.ts#L48"},"signature":["string | undefined"]},{"id":"def-server.NodesVersionCompatibility.incompatibleNodes","type":"Array","label":"incompatibleNodes","description":[],"source":{"path":"src/core/server/elasticsearch/version_check/ensure_es_version.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/version_check/ensure_es_version.ts#L49"},"signature":["NodeInfo[]"]},{"id":"def-server.NodesVersionCompatibility.warningNodes","type":"Array","label":"warningNodes","description":[],"source":{"path":"src/core/server/elasticsearch/version_check/ensure_es_version.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/version_check/ensure_es_version.ts#L50"},"signature":["NodeInfo[]"]},{"id":"def-server.NodesVersionCompatibility.kibanaVersion","type":"string","label":"kibanaVersion","description":[],"source":{"path":"src/core/server/elasticsearch/version_check/ensure_es_version.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/version_check/ensure_es_version.ts#L51"}}],"source":{"path":"src/core/server/elasticsearch/version_check/ensure_es_version.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/version_check/ensure_es_version.ts#L46"},"initialIsOpen":false},{"id":"def-server.LegacyAPICaller","type":"Interface","label":"LegacyAPICaller","description":[],"children":[{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":164,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L164"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":165,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L165"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":166,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L166"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":167,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L167"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":168,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L168"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":169,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L169"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":170,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L170"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":171,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L171"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":172,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L172"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":173,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L173"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":174,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L174"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":176,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L176"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":177,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L177"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":178,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L178"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":179,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L179"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":181,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L181"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":182,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L182"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":184,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L184"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":185,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L185"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":186,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L186"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":187,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L187"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":188,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L188"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":189,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L189"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":190,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L190"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":191,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L191"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":192,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L192"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":193,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L193"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":195,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L195"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":196,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L196"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":197,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L197"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":198,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L198"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":199,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L199"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":200,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L200"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":201,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L201"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":202,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L202"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":205,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L205"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":206,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L206"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":207,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L207"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":208,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L208"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":209,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L209"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":210,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L210"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":211,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L211"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":212,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L212"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":213,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L213"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":214,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L214"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":215,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L215"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":216,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L216"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":217,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L217"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":218,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L218"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":219,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L219"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":220,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L220"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":221,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L221"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":222,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L222"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":223,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L223"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":226,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L226"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":227,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L227"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":228,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L228"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":229,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L229"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":230,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L230"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":231,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L231"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":232,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L232"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":233,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L233"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":236,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L236"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":237,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L237"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":238,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L238"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":239,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L239"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":240,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L240"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":241,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L241"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":242,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L242"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":243,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L243"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":244,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L244"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":245,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L245"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":246,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L246"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":247,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L247"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":248,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L248"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":249,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L249"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":250,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L250"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":251,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L251"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":252,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L252"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":253,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L253"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":254,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L254"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":255,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L255"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":256,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L256"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":257,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L257"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":258,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L258"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":259,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L259"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":260,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L260"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":261,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L261"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":262,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L262"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":263,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L263"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":264,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L264"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":265,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L265"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":266,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L266"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":267,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L267"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":268,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L268"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":269,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L269"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":270,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L270"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":271,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L271"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":274,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L274"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":275,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L275"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":276,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L276"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":277,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L277"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":280,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L280"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":281,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L281"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":282,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L282"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":285,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L285"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":286,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L286"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":287,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L287"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":288,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L288"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":289,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L289"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":290,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L290"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":291,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L291"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":292,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L292"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":293,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L293"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":296,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L296"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":297,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L297"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":298,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L298"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":301,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L301"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":304,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L304"},"signature":["any"]},{"id":"def-server.LegacyAPICaller.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":309,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L309"},"signature":["any"]}],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":162,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L162"},"initialIsOpen":false},{"id":"def-server.FakeRequest","type":"Interface","label":"FakeRequest","description":["\nFake request object created manually by Kibana plugins."],"children":[{"id":"def-server.FakeRequest.headers","type":"CompoundType","label":"headers","description":["Headers used for authentication against Elasticsearch"],"source":{"path":"src/core/server/elasticsearch/types.ts","lineNumber":182,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/types.ts#L182"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.Headers","text":"Headers"}]}],"source":{"path":"src/core/server/elasticsearch/types.ts","lineNumber":180,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/types.ts#L180"},"initialIsOpen":false},{"id":"def-server.IClusterClient","type":"Interface","label":"IClusterClient","description":["\nRepresents an Elasticsearch cluster API client created by the platform.\nIt allows to call API on behalf of the internal Kibana user and\nthe actual user that is derived from the request headers (via `asScoped(...)`).\n"],"children":[{"id":"def-server.IClusterClient.asInternalUser","type":"CompoundType","label":"asInternalUser","description":["\nA {@link ElasticsearchClient | client} to be used to query the ES cluster on behalf of the Kibana internal user"],"source":{"path":"src/core/server/elasticsearch/client/cluster_client.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/cluster_client.ts#L33"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ElasticsearchClient","text":"ElasticsearchClient"}]},{"id":"def-server.IClusterClient.asScoped","type":"Function","label":"asScoped","description":["\nCreates a {@link IScopedClusterClient | scoped cluster client} bound to given {@link ScopeableRequest | request}"],"source":{"path":"src/core/server/elasticsearch/client/cluster_client.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/cluster_client.ts#L37"},"signature":["(request: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ScopeableRequest","text":"ScopeableRequest"},") => ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.IScopedClusterClient","text":"IScopedClusterClient"}]}],"source":{"path":"src/core/server/elasticsearch/client/cluster_client.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/cluster_client.ts#L29"},"initialIsOpen":false},{"id":"def-server.ICustomClusterClient","type":"Interface","label":"ICustomClusterClient","signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ICustomClusterClient","text":"ICustomClusterClient"}," extends ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.IClusterClient","text":"IClusterClient"}],"description":["\nSee {@link IClusterClient}\n"],"children":[{"id":"def-server.ICustomClusterClient.close","type":"Function","label":"close","description":["\nCloses the cluster client. After that client cannot be used and one should\ncreate a new client instance to be able to interact with Elasticsearch API."],"source":{"path":"src/core/server/elasticsearch/client/cluster_client.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/cluster_client.ts#L50"},"signature":["() => Promise"]}],"source":{"path":"src/core/server/elasticsearch/client/cluster_client.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/cluster_client.ts#L45"},"initialIsOpen":false},{"id":"def-server.IScopedClusterClient","type":"Interface","label":"IScopedClusterClient","description":["\nServes the same purpose as the normal {@link IClusterClient | cluster client} but exposes\nan additional `asCurrentUser` method that doesn't use credentials of the Kibana internal\nuser (as `asInternalUser` does) to request Elasticsearch API, but rather passes HTTP headers\nextracted from the current user request to the API instead.\n"],"children":[{"id":"def-server.IScopedClusterClient.asInternalUser","type":"CompoundType","label":"asInternalUser","description":["\nA {@link ElasticsearchClient | client} to be used to query the elasticsearch cluster\non behalf of the internal Kibana user."],"source":{"path":"src/core/server/elasticsearch/client/scoped_cluster_client.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/scoped_cluster_client.ts#L24"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ElasticsearchClient","text":"ElasticsearchClient"}]},{"id":"def-server.IScopedClusterClient.asCurrentUser","type":"CompoundType","label":"asCurrentUser","description":["\nA {@link ElasticsearchClient | client} to be used to query the elasticsearch cluster\non behalf of the user that initiated the request to the Kibana server."],"source":{"path":"src/core/server/elasticsearch/client/scoped_cluster_client.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/scoped_cluster_client.ts#L29"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ElasticsearchClient","text":"ElasticsearchClient"}]}],"source":{"path":"src/core/server/elasticsearch/client/scoped_cluster_client.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/scoped_cluster_client.ts#L19"},"initialIsOpen":false},{"id":"def-server.SearchResponse","type":"Interface","label":"SearchResponse","signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.SearchResponse","text":"SearchResponse"},""],"description":[],"children":[{"id":"def-server.SearchResponse.took","type":"number","label":"took","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L80"}},{"id":"def-server.SearchResponse.timed_out","type":"boolean","label":"timed_out","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L81"}},{"id":"def-server.SearchResponse._scroll_id","type":"string","label":"_scroll_id","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L82"},"signature":["string | undefined"]},{"id":"def-server.SearchResponse._shards","type":"Object","label":"_shards","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L83"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ShardsResponse","text":"ShardsResponse"}]},{"id":"def-server.SearchResponse.hits","type":"Object","label":"hits","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L84"},"signature":["{ total: number; max_score: number; hits: { _index: string; _type: string; _id: string; _score: number; _source: T; _version?: number | undefined; _explanation?: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.Explanation","text":"Explanation"}," | undefined; fields?: any; highlight?: any; inner_hits?: any; matched_queries?: string[] | undefined; sort?: unknown[] | undefined; }[]; }"]},{"id":"def-server.SearchResponse.aggregations","type":"Any","label":"aggregations","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L102"},"signature":["any"]},{"id":"def-server.SearchResponse.pit_id","type":"string","label":"pit_id","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L103"},"signature":["string | undefined"]}],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L79"},"initialIsOpen":false},{"id":"def-server.CountResponse","type":"Interface","label":"CountResponse","description":[],"children":[{"id":"def-server.CountResponse._shards","type":"Object","label":"_shards","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L72"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ShardsInfo","text":"ShardsInfo"}]},{"id":"def-server.CountResponse.count","type":"number","label":"count","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L73"}}],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L71"},"initialIsOpen":false},{"id":"def-server.ShardsInfo","type":"Interface","label":"ShardsInfo","description":[],"children":[{"id":"def-server.ShardsInfo.total","type":"number","label":"total","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L62"}},{"id":"def-server.ShardsInfo.successful","type":"number","label":"successful","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L63"}},{"id":"def-server.ShardsInfo.skipped","type":"number","label":"skipped","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L64"}},{"id":"def-server.ShardsInfo.failed","type":"number","label":"failed","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L65"}}],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L61"},"initialIsOpen":false},{"id":"def-server.ShardsResponse","type":"Interface","label":"ShardsResponse","description":["\nAll response typings are maintained until elasticsearch-js provides them out of the box\nhttps://github.com/elastic/elasticsearch-js/pull/970\n"],"children":[{"id":"def-server.ShardsResponse.total","type":"number","label":"total","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L43"}},{"id":"def-server.ShardsResponse.successful","type":"number","label":"successful","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L44"}},{"id":"def-server.ShardsResponse.failed","type":"number","label":"failed","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L45"}},{"id":"def-server.ShardsResponse.skipped","type":"number","label":"skipped","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L46"}}],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L42"},"initialIsOpen":false},{"id":"def-server.Explanation","type":"Interface","label":"Explanation","description":[],"children":[{"id":"def-server.Explanation.value","type":"number","label":"value","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L53"}},{"id":"def-server.Explanation.description","type":"string","label":"description","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L54"}},{"id":"def-server.Explanation.details","type":"Array","label":"details","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L55"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.Explanation","text":"Explanation"},"[]"]}],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L52"},"initialIsOpen":false},{"id":"def-server.GetResponse","type":"Interface","label":"GetResponse","signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.GetResponse","text":"GetResponse"},""],"description":[],"children":[{"id":"def-server.GetResponse._index","type":"string","label":"_index","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L110"}},{"id":"def-server.GetResponse._type","type":"string","label":"_type","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":111,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L111"}},{"id":"def-server.GetResponse._id","type":"string","label":"_id","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":112,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L112"}},{"id":"def-server.GetResponse._version","type":"number","label":"_version","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":113,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L113"}},{"id":"def-server.GetResponse._routing","type":"string","label":"_routing","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":114,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L114"},"signature":["string | undefined"]},{"id":"def-server.GetResponse.found","type":"boolean","label":"found","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L115"}},{"id":"def-server.GetResponse._source","type":"Uncategorized","label":"_source","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L116"},"signature":["T"]},{"id":"def-server.GetResponse._seq_no","type":"number","label":"_seq_no","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":117,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L117"}},{"id":"def-server.GetResponse._primary_term","type":"number","label":"_primary_term","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":118,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L118"}}],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":109,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L109"},"initialIsOpen":false},{"id":"def-server.DeleteDocumentResponse","type":"Interface","label":"DeleteDocumentResponse","description":[],"children":[{"id":"def-server.DeleteDocumentResponse._shards","type":"Object","label":"_shards","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":125,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L125"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ShardsResponse","text":"ShardsResponse"}]},{"id":"def-server.DeleteDocumentResponse.found","type":"boolean","label":"found","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":126,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L126"}},{"id":"def-server.DeleteDocumentResponse._index","type":"string","label":"_index","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":127,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L127"}},{"id":"def-server.DeleteDocumentResponse._type","type":"string","label":"_type","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":128,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L128"}},{"id":"def-server.DeleteDocumentResponse._id","type":"string","label":"_id","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":129,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L129"}},{"id":"def-server.DeleteDocumentResponse._version","type":"number","label":"_version","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":130,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L130"}},{"id":"def-server.DeleteDocumentResponse.result","type":"string","label":"result","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L131"}},{"id":"def-server.DeleteDocumentResponse.error","type":"Object","label":"error","description":[],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":132,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L132"},"signature":["{ type: string; } | undefined"]}],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":124,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L124"},"initialIsOpen":false},{"id":"def-server.IExternalUrlConfig","type":"Interface","label":"IExternalUrlConfig","description":["\nExternal Url configuration for use in Kibana."],"children":[{"id":"def-server.IExternalUrlConfig.policy","type":"Array","label":"policy","description":["\nA set of policies describing which external urls are allowed."],"source":{"path":"src/core/server/external_url/external_url_config.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/external_url/external_url_config.ts#L22"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.IExternalUrlPolicy","text":"IExternalUrlPolicy"},"[]"]}],"source":{"path":"src/core/server/external_url/external_url_config.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/external_url/external_url_config.ts#L18"},"initialIsOpen":false},{"id":"def-server.IExternalUrlPolicy","type":"Interface","label":"IExternalUrlPolicy","description":["\nA policy describing whether access to an external destination is allowed."],"children":[{"id":"def-server.IExternalUrlPolicy.allow","type":"boolean","label":"allow","description":["\nIndicates if this policy allows or denies access to the described destination."],"source":{"path":"src/core/server/external_url/external_url_config.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/external_url/external_url_config.ts#L33"}},{"id":"def-server.IExternalUrlPolicy.host","type":"string","label":"host","description":["\nOptional host describing the external destination.\nMay be combined with `protocol`.\n"],"source":{"path":"src/core/server/external_url/external_url_config.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/external_url/external_url_config.ts#L46"},"signature":["string | undefined"]},{"id":"def-server.IExternalUrlPolicy.protocol","type":"string","label":"protocol","description":["\nOptional protocol describing the external destination.\nMay be combined with `host`.\n"],"source":{"path":"src/core/server/external_url/external_url_config.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/external_url/external_url_config.ts#L59"},"signature":["string | undefined"]}],"source":{"path":"src/core/server/external_url/external_url_config.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/external_url/external_url_config.ts#L29"},"initialIsOpen":false},{"id":"def-server.HttpResourcesRenderOptions","type":"Interface","label":"HttpResourcesRenderOptions","description":["\nAllows to configure HTTP response parameters"],"children":[{"id":"def-server.HttpResourcesRenderOptions.headers","type":"CompoundType","label":"headers","description":["\nHTTP Headers with additional information about response."],"source":{"path":"src/core/server/http_resources/types.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http_resources/types.ts#L30"},"signature":["Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]> | Record | undefined"]}],"source":{"path":"src/core/server/http_resources/types.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http_resources/types.ts#L24"},"initialIsOpen":false},{"id":"def-server.HttpResourcesServiceToolkit","type":"Interface","label":"HttpResourcesServiceToolkit","description":["\nExtended set of {@link KibanaResponseFactory} helpers used to respond with HTML or JS resource."],"children":[{"id":"def-server.HttpResourcesServiceToolkit.renderCoreApp","type":"Function","label":"renderCoreApp","description":["To respond with HTML page bootstrapping Kibana application."],"source":{"path":"src/core/server/http_resources/types.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http_resources/types.ts#L45"},"signature":["(options?: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.HttpResourcesRenderOptions","text":"HttpResourcesRenderOptions"}," | undefined) => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.IKibanaResponse","text":"IKibanaResponse"},">"]},{"id":"def-server.HttpResourcesServiceToolkit.renderAnonymousCoreApp","type":"Function","label":"renderAnonymousCoreApp","description":["To respond with HTML page bootstrapping Kibana application without retrieving user-specific information."],"source":{"path":"src/core/server/http_resources/types.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http_resources/types.ts#L47"},"signature":["(options?: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.HttpResourcesRenderOptions","text":"HttpResourcesRenderOptions"}," | undefined) => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.IKibanaResponse","text":"IKibanaResponse"},">"]},{"id":"def-server.HttpResourcesServiceToolkit.renderHtml","type":"Function","label":"renderHtml","description":["To respond with a custom HTML page."],"source":{"path":"src/core/server/http_resources/types.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http_resources/types.ts#L49"},"signature":["(options: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.HttpResponseOptions","text":"HttpResponseOptions"},") => ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.IKibanaResponse","text":"IKibanaResponse"},""]},{"id":"def-server.HttpResourcesServiceToolkit.renderJs","type":"Function","label":"renderJs","description":["To respond with a custom JS script file."],"source":{"path":"src/core/server/http_resources/types.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http_resources/types.ts#L51"},"signature":["(options: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.HttpResponseOptions","text":"HttpResponseOptions"},") => ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.IKibanaResponse","text":"IKibanaResponse"},""]}],"source":{"path":"src/core/server/http_resources/types.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http_resources/types.ts#L43"},"initialIsOpen":false},{"id":"def-server.IRenderOptions","type":"Interface","label":"IRenderOptions","description":[],"children":[{"id":"def-server.IRenderOptions.includeUserSettings","type":"CompoundType","label":"includeUserSettings","description":["\nSet whether to output user settings in the page metadata.\n`true` by default."],"source":{"path":"src/core/server/rendering/types.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/rendering/types.ts#L72"},"signature":["boolean | undefined"]},{"id":"def-server.IRenderOptions.vars","type":"Object","label":"vars","description":["\nInject custom vars into the page metadata."],"source":{"path":"src/core/server/rendering/types.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/rendering/types.ts#L79"},"signature":["Record | undefined"]}],"source":{"path":"src/core/server/rendering/types.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/rendering/types.ts#L67"},"initialIsOpen":false},{"id":"def-server.Logger","type":"Interface","label":"Logger","signature":["Logger"],"description":["\nLogger exposes all the necessary methods to log any type of information and\nthis is the interface used by the logging consumers including plugins.\n"],"children":[{"id":"def-server.Logger.trace","type":"Function","label":"trace","signature":["(message: string, meta?: ","LogMeta"," | undefined) => void"],"description":["\nLog messages at the most detailed log level\n"],"children":[{"type":"string","label":"message","isRequired":true,"signature":["string"],"description":["- The log message"],"source":{"path":"node_modules/@kbn/logging/target/logger.d.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L23"}},{"type":"Object","label":"meta","isRequired":false,"signature":["LogMeta"," | undefined"],"description":["-"],"source":{"path":"node_modules/@kbn/logging/target/logger.d.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L23"}}],"tags":[],"returnComment":[],"source":{"path":"node_modules/@kbn/logging/target/logger.d.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L23"}},{"id":"def-server.Logger.debug","type":"Function","label":"debug","signature":["(message: string, meta?: ","LogMeta"," | undefined) => void"],"description":["\nLog messages useful for debugging and interactive investigation"],"children":[{"type":"string","label":"message","isRequired":true,"signature":["string"],"description":["- The log message"],"source":{"path":"node_modules/@kbn/logging/target/logger.d.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L29"}},{"type":"Object","label":"meta","isRequired":false,"signature":["LogMeta"," | undefined"],"description":["-"],"source":{"path":"node_modules/@kbn/logging/target/logger.d.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L29"}}],"tags":[],"returnComment":[],"source":{"path":"node_modules/@kbn/logging/target/logger.d.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L29"}},{"id":"def-server.Logger.info","type":"Function","label":"info","signature":["(message: string, meta?: ","LogMeta"," | undefined) => void"],"description":["\nLogs messages related to general application flow"],"children":[{"type":"string","label":"message","isRequired":true,"signature":["string"],"description":["- The log message"],"source":{"path":"node_modules/@kbn/logging/target/logger.d.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L35"}},{"type":"Object","label":"meta","isRequired":false,"signature":["LogMeta"," | undefined"],"description":["-"],"source":{"path":"node_modules/@kbn/logging/target/logger.d.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L35"}}],"tags":[],"returnComment":[],"source":{"path":"node_modules/@kbn/logging/target/logger.d.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L35"}},{"id":"def-server.Logger.warn","type":"Function","label":"warn","signature":["(errorOrMessage: string | Error, meta?: ","LogMeta"," | undefined) => void"],"description":["\nLogs abnormal or unexpected errors or messages"],"children":[{"type":"CompoundType","label":"errorOrMessage","isRequired":true,"signature":["string | Error"],"description":["- An Error object or message string to log"],"source":{"path":"node_modules/@kbn/logging/target/logger.d.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L41"}},{"type":"Object","label":"meta","isRequired":false,"signature":["LogMeta"," | undefined"],"description":["-"],"source":{"path":"node_modules/@kbn/logging/target/logger.d.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L41"}}],"tags":[],"returnComment":[],"source":{"path":"node_modules/@kbn/logging/target/logger.d.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L41"}},{"id":"def-server.Logger.error","type":"Function","label":"error","signature":["(errorOrMessage: string | Error, meta?: ","LogMeta"," | undefined) => void"],"description":["\nLogs abnormal or unexpected errors or messages that caused a failure in the application flow\n"],"children":[{"type":"CompoundType","label":"errorOrMessage","isRequired":true,"signature":["string | Error"],"description":["- An Error object or message string to log"],"source":{"path":"node_modules/@kbn/logging/target/logger.d.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L48"}},{"type":"Object","label":"meta","isRequired":false,"signature":["LogMeta"," | undefined"],"description":["-"],"source":{"path":"node_modules/@kbn/logging/target/logger.d.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L48"}}],"tags":[],"returnComment":[],"source":{"path":"node_modules/@kbn/logging/target/logger.d.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L48"}},{"id":"def-server.Logger.fatal","type":"Function","label":"fatal","signature":["(errorOrMessage: string | Error, meta?: ","LogMeta"," | undefined) => void"],"description":["\nLogs abnormal or unexpected errors or messages that caused an unrecoverable failure\n"],"children":[{"type":"CompoundType","label":"errorOrMessage","isRequired":true,"signature":["string | Error"],"description":["- An Error object or message string to log"],"source":{"path":"node_modules/@kbn/logging/target/logger.d.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L55"}},{"type":"Object","label":"meta","isRequired":false,"signature":["LogMeta"," | undefined"],"description":["-"],"source":{"path":"node_modules/@kbn/logging/target/logger.d.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L55"}}],"tags":[],"returnComment":[],"source":{"path":"node_modules/@kbn/logging/target/logger.d.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L55"}},{"id":"def-server.Logger.log","type":"Function","label":"log","signature":["(record: ","LogRecord",") => void"],"description":[],"children":[{"type":"Object","label":"record","isRequired":true,"signature":["LogRecord"],"description":[],"source":{"path":"node_modules/@kbn/logging/target/logger.d.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L57"}}],"tags":["internal"],"returnComment":[],"source":{"path":"node_modules/@kbn/logging/target/logger.d.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L57"}},{"id":"def-server.Logger.get","type":"Function","label":"get","signature":["(...childContextPaths: string[]) => ","Logger"],"description":["\nReturns a new {@link Logger} instance extending the current logger context.\n"],"children":[{"type":"Array","label":"childContextPaths","isRequired":true,"signature":["string[]"],"description":[],"source":{"path":"node_modules/@kbn/logging/target/logger.d.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L67"}}],"tags":["example"],"returnComment":[],"source":{"path":"node_modules/@kbn/logging/target/logger.d.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L67"}}],"source":{"path":"node_modules/@kbn/logging/target/logger.d.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L16"},"initialIsOpen":false},{"id":"def-server.LoggerFactory","type":"Interface","label":"LoggerFactory","signature":["LoggerFactory"],"description":["\nThe single purpose of `LoggerFactory` interface is to define a way to\nretrieve a context-based logger instance.\n"],"children":[{"id":"def-server.LoggerFactory.get","type":"Function","label":"get","signature":["(...contextParts: string[]) => ","Logger"],"description":["\nReturns a `Logger` instance for the specified context.\n"],"children":[{"type":"Array","label":"contextParts","isRequired":true,"signature":["string[]"],"description":["- Parts of the context to return logger for. For example\nget('plugins', 'pid') will return a logger for the `plugins.pid` context."],"source":{"path":"node_modules/@kbn/logging/target/logger_factory.d.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger_factory.d.ts#L15"}}],"tags":[],"returnComment":[],"source":{"path":"node_modules/@kbn/logging/target/logger_factory.d.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger_factory.d.ts#L15"}}],"source":{"path":"node_modules/@kbn/logging/target/logger_factory.d.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger_factory.d.ts#L8"},"initialIsOpen":false},{"id":"def-server.LogMeta","type":"Interface","label":"LogMeta","signature":["LogMeta"],"description":["\nContextual metadata\n"],"children":[{"id":"def-server.LogMeta.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"node_modules/@kbn/logging/target/logger.d.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L8"},"signature":["any"]}],"source":{"path":"node_modules/@kbn/logging/target/logger.d.ts","lineNumber":7,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/logger.d.ts#L7"},"initialIsOpen":false},{"id":"def-server.LogRecord","type":"Interface","label":"LogRecord","signature":["LogRecord"],"description":["\nEssential parts of every log message."],"children":[{"id":"def-server.LogRecord.timestamp","type":"Object","label":"timestamp","description":[],"source":{"path":"node_modules/@kbn/logging/target/log_record.d.ts","lineNumber":7,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/log_record.d.ts#L7"},"signature":["Date"]},{"id":"def-server.LogRecord.level","type":"Object","label":"level","description":[],"source":{"path":"node_modules/@kbn/logging/target/log_record.d.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/log_record.d.ts#L8"},"signature":["LogLevel"]},{"id":"def-server.LogRecord.context","type":"string","label":"context","description":[],"source":{"path":"node_modules/@kbn/logging/target/log_record.d.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/log_record.d.ts#L9"}},{"id":"def-server.LogRecord.message","type":"string","label":"message","description":[],"source":{"path":"node_modules/@kbn/logging/target/log_record.d.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/log_record.d.ts#L10"}},{"id":"def-server.LogRecord.error","type":"Object","label":"error","description":[],"source":{"path":"node_modules/@kbn/logging/target/log_record.d.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/log_record.d.ts#L11"},"signature":["Error | undefined"]},{"id":"def-server.LogRecord.meta","type":"Object","label":"meta","description":[],"source":{"path":"node_modules/@kbn/logging/target/log_record.d.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/log_record.d.ts#L12"},"signature":["{ [name: string]: any; } | undefined"]},{"id":"def-server.LogRecord.pid","type":"number","label":"pid","description":[],"source":{"path":"node_modules/@kbn/logging/target/log_record.d.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/log_record.d.ts#L15"}}],"source":{"path":"node_modules/@kbn/logging/target/log_record.d.ts","lineNumber":6,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/logging/target/log_record.d.ts#L6"},"initialIsOpen":false},{"id":"def-server.LoggingServiceSetup","type":"Interface","label":"LoggingServiceSetup","description":["\nProvides APIs to plugins for customizing the plugin's logger."],"children":[{"id":"def-server.LoggingServiceSetup.configure","type":"Function","label":"configure","signature":["(config$: ","Observable","<",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.LoggerContextConfigInput","text":"LoggerContextConfigInput"},">) => void"],"description":["\nCustomizes the logging config for the plugin's context.\n"],"children":[{"type":"Object","label":"config$","isRequired":true,"signature":["Observable","<",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.LoggerContextConfigInput","text":"LoggerContextConfigInput"},">"],"description":[],"source":{"path":"src/core/server/logging/logging_service.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/logging/logging_service.ts#L41"}}],"tags":["remarks","example"],"returnComment":[],"source":{"path":"src/core/server/logging/logging_service.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/logging/logging_service.ts#L41"}}],"source":{"path":"src/core/server/logging/logging_service.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/logging/logging_service.ts#L20"},"initialIsOpen":false},{"id":"def-server.LoggerContextConfigInput","type":"Interface","label":"LoggerContextConfigInput","description":[],"children":[{"id":"def-server.LoggerContextConfigInput.appenders","type":"CompoundType","label":"appenders","description":[],"source":{"path":"src/core/server/logging/logging_config.ts","lineNumber":111,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/logging/logging_config.ts#L111"},"signature":["Record | Map | undefined"]},{"id":"def-server.LoggerContextConfigInput.loggers","type":"Array","label":"loggers","description":[],"source":{"path":"src/core/server/logging/logging_config.ts","lineNumber":112,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/logging/logging_config.ts#L112"},"signature":["Readonly<{} & { name: string; level: ","LogLevelId","; appenders: string[]; }>[] | undefined"]}],"source":{"path":"src/core/server/logging/logging_config.ts","lineNumber":109,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/logging/logging_config.ts#L109"},"initialIsOpen":false},{"id":"def-server.DiscoveredPlugin","type":"Interface","label":"DiscoveredPlugin","description":["\nSmall container object used to expose information about discovered plugins that may\nor may not have been started."],"children":[{"id":"def-server.DiscoveredPlugin.id","type":"string","label":"id","description":["\nIdentifier of the plugin."],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":189,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L189"}},{"id":"def-server.DiscoveredPlugin.configPath","type":"CompoundType","label":"configPath","description":["\nRoot configuration path used by the plugin, defaults to \"id\" in snake_case format."],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":194,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L194"},"signature":["string | string[]"]},{"id":"def-server.DiscoveredPlugin.requiredPlugins","type":"Object","label":"requiredPlugins","description":["\nAn optional list of the other plugins that **must be** installed and enabled\nfor this plugin to function properly."],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":200,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L200"},"signature":["readonly string[]"]},{"id":"def-server.DiscoveredPlugin.optionalPlugins","type":"Object","label":"optionalPlugins","description":["\nAn optional list of the other plugins that if installed and enabled **may be**\nleveraged by this plugin for some additional functionality but otherwise are\nnot required for this plugin to work properly."],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":207,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L207"},"signature":["readonly string[]"]},{"id":"def-server.DiscoveredPlugin.requiredBundles","type":"Object","label":"requiredBundles","description":["\nList of plugin ids that this plugin's UI code imports modules from that are\nnot in `requiredPlugins`.\n"],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":219,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L219"},"signature":["readonly string[]"]}],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":185,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L185"},"initialIsOpen":false},{"id":"def-server.Plugin","type":"Interface","label":"Plugin","signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.Plugin","text":"Plugin"},""],"description":["\nThe interface that should be returned by a `PluginInitializer`.\n"],"children":[{"id":"def-server.Plugin.setup","type":"Function","label":"setup","signature":["(core: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreSetup","text":"CoreSetup"},", plugins: TPluginsSetup) => TSetup"],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreSetup","text":"CoreSetup"},""],"description":[],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":252,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L252"}},{"type":"Uncategorized","label":"plugins","isRequired":true,"signature":["TPluginsSetup"],"description":[],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":252,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L252"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":252,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L252"}},{"id":"def-server.Plugin.start","type":"Function","label":"start","signature":["(core: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreStart","text":"CoreStart"},", plugins: TPluginsStart) => TStart"],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreStart","text":"CoreStart"}],"description":[],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":253,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L253"}},{"type":"Uncategorized","label":"plugins","isRequired":true,"signature":["TPluginsStart"],"description":[],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":253,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L253"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":253,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L253"}},{"id":"def-server.Plugin.stop","type":"Function","label":"stop","signature":["(() => void) | undefined"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":254,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L254"}}],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":246,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L246"},"initialIsOpen":false},{"id":"def-server.AsyncPlugin","type":"Interface","label":"AsyncPlugin","signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.AsyncPlugin","text":"AsyncPlugin"},""],"description":["\nA plugin with asynchronous lifecycle methods.\n"],"children":[{"id":"def-server.AsyncPlugin.setup","type":"Function","label":"setup","signature":["(core: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreSetup","text":"CoreSetup"},", plugins: TPluginsSetup) => TSetup | Promise"],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreSetup","text":"CoreSetup"},""],"description":[],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":269,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L269"}},{"type":"Uncategorized","label":"plugins","isRequired":true,"signature":["TPluginsSetup"],"description":[],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":269,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L269"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":269,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L269"}},{"id":"def-server.AsyncPlugin.start","type":"Function","label":"start","signature":["(core: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreStart","text":"CoreStart"},", plugins: TPluginsStart) => TStart | Promise"],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreStart","text":"CoreStart"}],"description":[],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":270,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L270"}},{"type":"Uncategorized","label":"plugins","isRequired":true,"signature":["TPluginsStart"],"description":[],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":270,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L270"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":270,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L270"}},{"id":"def-server.AsyncPlugin.stop","type":"Function","label":"stop","signature":["(() => void) | undefined"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":271,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L271"}}],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":263,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L263"},"initialIsOpen":false},{"id":"def-server.PluginConfigDescriptor","type":"Interface","label":"PluginConfigDescriptor","signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.PluginConfigDescriptor","text":"PluginConfigDescriptor"},""],"description":["\nDescribes a plugin configuration properties.\n"],"children":[{"id":"def-server.PluginConfigDescriptor.deprecations","type":"Function","label":"deprecations","description":["\nProvider for the {@link ConfigDeprecation} to apply to the plugin configuration."],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L62"},"signature":["ConfigDeprecationProvider"," | undefined"]},{"id":"def-server.PluginConfigDescriptor.exposeToBrowser","type":"Object","label":"exposeToBrowser","description":["\nList of configuration properties that will be available on the client-side plugin."],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L66"},"signature":["{ [P in keyof T]?: boolean | undefined; } | undefined"]},{"id":"def-server.PluginConfigDescriptor.schema","type":"Object","label":"schema","description":["\nSchema to use to validate the plugin configuration.\n\n{@link PluginConfigSchema}"],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L72"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.PluginConfigSchema","text":"PluginConfigSchema"},""]}],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L58"},"initialIsOpen":false},{"id":"def-server.PluginInitializerContext","type":"Interface","label":"PluginInitializerContext","signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.PluginInitializerContext","text":"PluginInitializerContext"},""],"description":["\nContext that's available to plugins during initialization stage.\n"],"children":[{"id":"def-server.PluginInitializerContext.opaqueId","type":"Uncategorized","label":"opaqueId","description":[],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":298,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L298"},"signature":["symbol"]},{"id":"def-server.PluginInitializerContext.env","type":"Object","label":"env","description":[],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":299,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L299"},"signature":["{ mode: ","EnvironmentMode","; packageInfo: Readonly<","PackageInfo",">; instanceUuid: string; }"]},{"id":"def-server.PluginInitializerContext.logger","type":"Object","label":"logger","description":["\n{@link LoggerFactory | logger factory} instance already bound to the plugin's logging context\n"],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":322,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L322"},"signature":["LoggerFactory"]},{"id":"def-server.PluginInitializerContext.config","type":"Object","label":"config","description":["\nAccessors for the plugin's configuration"],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":326,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L326"},"signature":["{ legacy: { globalConfig$: ","Observable"," moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly autocompleteTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; }>; elasticsearch: Readonly<{ readonly shardTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly requestTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly pingTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; }>; path: Readonly<{ readonly data: string; }>; savedObjects: Readonly<{ readonly maxImportPayloadBytes: Readonly<{ isGreaterThan: (other: ","ByteSizeValue",") => boolean; isLessThan: (other: ","ByteSizeValue",") => boolean; isEqualTo: (other: ","ByteSizeValue",") => boolean; getValueInBytes: () => number; toString: (returnUnit?: \"b\" | \"kb\" | \"mb\" | \"gb\" | undefined) => string; }>; }>; }>>; get: () => Readonly<{ kibana: Readonly<{ readonly index: string; readonly autocompleteTerminateAfter: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly autocompleteTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; }>; elasticsearch: Readonly<{ readonly shardTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly requestTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly pingTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; }>; path: Readonly<{ readonly data: string; }>; savedObjects: Readonly<{ readonly maxImportPayloadBytes: Readonly<{ isGreaterThan: (other: ","ByteSizeValue"]}],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":297,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L297"},"initialIsOpen":false},{"id":"def-server.PluginManifest","type":"Interface","label":"PluginManifest","description":["\nDescribes the set of required and optional properties plugin can define in its\nmandatory JSON manifest file.\n"],"children":[{"id":"def-server.PluginManifest.id","type":"string","label":"id","description":["\nIdentifier of the plugin. Must be a string in camelCase. Part of a plugin public contract.\nOther plugins leverage it to access plugin API, navigate to the plugin, etc."],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":107,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L107"}},{"id":"def-server.PluginManifest.version","type":"string","label":"version","description":["\nVersion of the plugin."],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":112,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L112"}},{"id":"def-server.PluginManifest.kibanaVersion","type":"string","label":"kibanaVersion","description":["\nThe version of Kibana the plugin is compatible with, defaults to \"version\"."],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":117,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L117"}},{"id":"def-server.PluginManifest.configPath","type":"CompoundType","label":"configPath","description":["\nRoot {@link ConfigPath | configuration path} used by the plugin, defaults\nto \"id\" in snake_case format.\n"],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":127,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L127"},"signature":["string | string[]"]},{"id":"def-server.PluginManifest.requiredPlugins","type":"Object","label":"requiredPlugins","description":["\nAn optional list of the other plugins that **must be** installed and enabled\nfor this plugin to function properly."],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":133,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L133"},"signature":["readonly string[]"]},{"id":"def-server.PluginManifest.requiredBundles","type":"Object","label":"requiredBundles","description":["\nList of plugin ids that this plugin's UI code imports modules from that are\nnot in `requiredPlugins`.\n"],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":145,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L145"},"signature":["readonly string[]"]},{"id":"def-server.PluginManifest.optionalPlugins","type":"Object","label":"optionalPlugins","description":["\nAn optional list of the other plugins that if installed and enabled **may be**\nleveraged by this plugin for some additional functionality but otherwise are\nnot required for this plugin to work properly."],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":152,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L152"},"signature":["readonly string[]"]},{"id":"def-server.PluginManifest.ui","type":"boolean","label":"ui","description":["\nSpecifies whether plugin includes some client/browser specific functionality\nthat should be included into client bundle via `public/ui_plugin.js` file."],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":158,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L158"}},{"id":"def-server.PluginManifest.server","type":"boolean","label":"server","description":["\nSpecifies whether plugin includes some server-side specific functionality."],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":163,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L163"}},{"id":"def-server.PluginManifest.extraPublicDirs","type":"Array","label":"extraPublicDirs","description":["\nSpecifies directory names that can be imported by other ui-plugins built\nusing the same instance of the @kbn/optimizer. A temporary measure we plan\nto replace with better mechanisms for sharing static code between plugins"],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":171,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L171"},"signature":["string[] | undefined"]},{"id":"def-server.PluginManifest.serviceFolders","type":"Object","label":"serviceFolders","description":["\nOnly used for the automatically generated API documentation. Specifying service\nfolders will cause your plugin API reference to be broken up into sub sections."],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":177,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L177"},"signature":["readonly string[] | undefined"]}],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L102"},"initialIsOpen":false},{"id":"def-server.IUiSettingsClient","type":"Interface","label":"IUiSettingsClient","description":["\nServer-side client that provides access to the advanced settings stored in elasticsearch.\nThe settings provide control over the behavior of the Kibana application.\nFor example, a user can specify how to display numeric or date fields.\nUsers can adjust the settings via Management UI.\n"],"children":[{"id":"def-server.IUiSettingsClient.getRegistered","type":"Function","label":"getRegistered","description":["\nReturns registered uiSettings values {@link UiSettingsParams}"],"source":{"path":"src/core/server/ui_settings/types.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L35"},"signature":["() => Readonly, \"type\" | \"options\" | \"description\" | \"name\" | \"order\" | \"value\" | \"category\" | \"metric\" | \"optionLabels\" | \"requiresPageReload\" | \"readonly\" | \"sensitive\" | \"deprecation\" | \"validation\">>>"]},{"id":"def-server.IUiSettingsClient.get","type":"Function","label":"get","description":["\nRetrieves uiSettings values set by the user with fallbacks to default values if not specified."],"source":{"path":"src/core/server/ui_settings/types.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L39"},"signature":["(key: string) => Promise"]},{"id":"def-server.IUiSettingsClient.getAll","type":"Function","label":"getAll","description":["\nRetrieves a set of all uiSettings values set by the user with fallbacks to default values if not specified."],"source":{"path":"src/core/server/ui_settings/types.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L43"},"signature":["() => Promise>"]},{"id":"def-server.IUiSettingsClient.getUserProvided","type":"Function","label":"getUserProvided","description":["\nRetrieves a set of all uiSettings values set by the user."],"source":{"path":"src/core/server/ui_settings/types.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L47"},"signature":["() => Promise>>"]},{"id":"def-server.IUiSettingsClient.setMany","type":"Function","label":"setMany","description":["\nWrites multiple uiSettings values and marks them as set by the user."],"source":{"path":"src/core/server/ui_settings/types.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L51"},"signature":["(changes: Record) => Promise"]},{"id":"def-server.IUiSettingsClient.set","type":"Function","label":"set","description":["\nWrites uiSettings value and marks it as set by the user."],"source":{"path":"src/core/server/ui_settings/types.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L55"},"signature":["(key: string, value: any) => Promise"]},{"id":"def-server.IUiSettingsClient.remove","type":"Function","label":"remove","description":["\nRemoves uiSettings value by key."],"source":{"path":"src/core/server/ui_settings/types.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L59"},"signature":["(key: string) => Promise"]},{"id":"def-server.IUiSettingsClient.removeMany","type":"Function","label":"removeMany","description":["\nRemoves multiple uiSettings values by keys."],"source":{"path":"src/core/server/ui_settings/types.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L63"},"signature":["(keys: string[]) => Promise"]},{"id":"def-server.IUiSettingsClient.isOverridden","type":"Function","label":"isOverridden","description":["\nShows whether the uiSettings value set by the user."],"source":{"path":"src/core/server/ui_settings/types.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L67"},"signature":["(key: string) => boolean"]},{"id":"def-server.IUiSettingsClient.isSensitive","type":"Function","label":"isSensitive","description":["\nShows whether the uiSetting is a sensitive value. Used by telemetry to not send sensitive values."],"source":{"path":"src/core/server/ui_settings/types.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L71"},"signature":["(key: string) => boolean"]}],"source":{"path":"src/core/server/ui_settings/types.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L31"},"initialIsOpen":false},{"id":"def-server.UiSettingsParams","type":"Interface","label":"UiSettingsParams","signature":["UiSettingsParams",""],"description":["\nUiSettings parameters defined by the plugins."],"children":[{"id":"def-server.UiSettingsParams.name","type":"string","label":"name","description":["title in the UI"],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L45"},"signature":["string | undefined"]},{"id":"def-server.UiSettingsParams.value","type":"Uncategorized","label":"value","description":["default value to fall back to if a user doesn't provide any"],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L47"},"signature":["T | undefined"]},{"id":"def-server.UiSettingsParams.description","type":"string","label":"description","description":["description provided to a user in UI"],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L49"},"signature":["string | undefined"]},{"id":"def-server.UiSettingsParams.category","type":"Array","label":"category","description":["used to group the configured setting in the UI"],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L51"},"signature":["string[] | undefined"]},{"id":"def-server.UiSettingsParams.options","type":"Array","label":"options","description":["array of permitted values for this setting"],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L53"},"signature":["string[] | undefined"]},{"id":"def-server.UiSettingsParams.optionLabels","type":"Object","label":"optionLabels","description":["text labels for 'select' type UI element"],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L55"},"signature":["Record | undefined"]},{"id":"def-server.UiSettingsParams.requiresPageReload","type":"CompoundType","label":"requiresPageReload","description":["a flag indicating whether new value applying requires page reloading"],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L57"},"signature":["boolean | undefined"]},{"id":"def-server.UiSettingsParams.readonly","type":"CompoundType","label":"readonly","description":["a flag indicating that value cannot be changed"],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L59"},"signature":["boolean | undefined"]},{"id":"def-server.UiSettingsParams.sensitive","type":"CompoundType","label":"sensitive","description":["\na flag indicating that value might contain user sensitive data.\nused by telemetry to mask the value of the setting when sent."],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L64"},"signature":["boolean | undefined"]},{"id":"def-server.UiSettingsParams.type","type":"CompoundType","label":"type","description":["defines a type of UI element {@link UiSettingsType}"],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L66"},"signature":["\"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"json\" | \"image\" | \"select\" | \"array\" | \"markdown\" | undefined"]},{"id":"def-server.UiSettingsParams.deprecation","type":"Object","label":"deprecation","description":["optional deprecation information. Used to generate a deprecation warning."],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L68"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.DeprecationSettings","text":"DeprecationSettings"}," | undefined"]},{"id":"def-server.UiSettingsParams.order","type":"number","label":"order","description":["\nindex of the settings within its category (ascending order, smallest will be displayed first).\nUsed for ordering in the UI.\n"],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L75"},"signature":["number | undefined"]},{"id":"def-server.UiSettingsParams.validation","type":"CompoundType","label":"validation","description":[],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L81"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.ImageValidation","text":"ImageValidation"}," | ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.StringValidationRegex","text":"StringValidationRegex"}," | ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.StringValidationRegexString","text":"StringValidationRegexString"}," | undefined"]},{"id":"def-server.UiSettingsParams.schema","type":"Object","label":"schema","description":[],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L86"},"signature":["Type",""]},{"id":"def-server.UiSettingsParams.metric","type":"Object","label":"metric","description":["\nMetric to track once this property changes"],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L92"},"signature":["{ type: ","UiCounterMetricType","; name: string; } | undefined"]}],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L43"},"initialIsOpen":false},{"id":"def-server.UiSettingsServiceSetup","type":"Interface","label":"UiSettingsServiceSetup","description":[],"children":[{"id":"def-server.UiSettingsServiceSetup.register","type":"Function","label":"register","signature":["(settings: Record>) => void"],"description":["\nSets settings with default values for the uiSettings."],"children":[{"type":"Object","label":"settings","isRequired":true,"signature":["Record>"],"description":[],"source":{"path":"src/core/server/ui_settings/types.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L102"}}],"tags":["example"],"returnComment":[],"source":{"path":"src/core/server/ui_settings/types.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L102"}}],"source":{"path":"src/core/server/ui_settings/types.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L84"},"initialIsOpen":false},{"id":"def-server.UiSettingsServiceStart","type":"Interface","label":"UiSettingsServiceStart","description":[],"children":[{"id":"def-server.UiSettingsServiceStart.asScopedToClient","type":"Function","label":"asScopedToClient","signature":["(savedObjectsClient: Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">) => ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.IUiSettingsClient","text":"IUiSettingsClient"}],"description":["\nCreates a {@link IUiSettingsClient} with provided *scoped* saved objects client.\n\nThis should only be used in the specific case where the client needs to be accessed\nfrom outside of the scope of a {@link RequestHandler}.\n"],"children":[{"type":"Object","label":"savedObjectsClient","isRequired":true,"signature":["Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">"],"description":[],"source":{"path":"src/core/server/ui_settings/types.ts","lineNumber":121,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L121"}}],"tags":["example"],"returnComment":[],"source":{"path":"src/core/server/ui_settings/types.ts","lineNumber":121,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L121"}}],"source":{"path":"src/core/server/ui_settings/types.ts","lineNumber":106,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/ui_settings/types.ts#L106"},"initialIsOpen":false},{"id":"def-server.UserProvidedValues","type":"Interface","label":"UserProvidedValues","signature":["UserProvidedValues",""],"description":["\nDescribes the values explicitly set by user."],"children":[{"id":"def-server.UserProvidedValues.userValue","type":"Uncategorized","label":"userValue","description":[],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":143,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L143"},"signature":["T | undefined"]},{"id":"def-server.UserProvidedValues.isOverridden","type":"CompoundType","label":"isOverridden","description":[],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":144,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L144"},"signature":["boolean | undefined"]}],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":142,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L142"},"initialIsOpen":false},{"id":"def-server.ImageValidation","type":"Interface","label":"ImageValidation","description":[],"children":[{"id":"def-server.ImageValidation.maxSize","type":"Object","label":"maxSize","description":[],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":132,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L132"},"signature":["{ length: number; description: string; }"]}],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L131"},"initialIsOpen":false},{"id":"def-server.DeprecationSettings","type":"Interface","label":"DeprecationSettings","description":["\nUiSettings deprecation field options."],"children":[{"id":"def-server.DeprecationSettings.message","type":"string","label":"message","description":["Deprecation message"],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L34"}},{"id":"def-server.DeprecationSettings.docLinksKey","type":"string","label":"docLinksKey","description":["Key to documentation links"],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L36"}}],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L32"},"initialIsOpen":false},{"id":"def-server.StringValidationRegex","type":"Interface","label":"StringValidationRegex","description":["\nStringValidation with regex object"],"children":[{"id":"def-server.StringValidationRegex.regex","type":"Object","label":"regex","description":[],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L115"},"signature":["RegExp"]},{"id":"def-server.StringValidationRegex.message","type":"string","label":"message","description":[],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L116"}}],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":114,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L114"},"initialIsOpen":false},{"id":"def-server.StringValidationRegexString","type":"Interface","label":"StringValidationRegexString","description":["\nStringValidation as regex string"],"children":[{"id":"def-server.StringValidationRegexString.regexString","type":"string","label":"regexString","description":[],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":124,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L124"}},{"id":"def-server.StringValidationRegexString.message","type":"string","label":"message","description":[],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":125,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L125"}}],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":123,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L123"},"initialIsOpen":false},{"id":"def-server.OpsMetrics","type":"Interface","label":"OpsMetrics","description":["\nRegroups metrics gathered by all the collectors.\nThis contains metrics about the os/runtime, the kibana process and the http server.\n"],"children":[{"id":"def-server.OpsMetrics.collected_at","type":"Object","label":"collected_at","description":["Time metrics were recorded at."],"source":{"path":"src/core/server/metrics/types.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/types.ts#L53"},"signature":["Date"]},{"id":"def-server.OpsMetrics.process","type":"Object","label":"process","description":["Process related metrics"],"source":{"path":"src/core/server/metrics/types.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/types.ts#L55"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.OpsProcessMetrics","text":"OpsProcessMetrics"}]},{"id":"def-server.OpsMetrics.os","type":"Object","label":"os","description":["OS related metrics"],"source":{"path":"src/core/server/metrics/types.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/types.ts#L57"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.OpsOsMetrics","text":"OpsOsMetrics"}]},{"id":"def-server.OpsMetrics.response_times","type":"Object","label":"response_times","description":["server response time stats"],"source":{"path":"src/core/server/metrics/types.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/types.ts#L59"},"signature":["{ avg_in_millis: number; max_in_millis: number; }"]},{"id":"def-server.OpsMetrics.requests","type":"Object","label":"requests","description":["server requests stats"],"source":{"path":"src/core/server/metrics/types.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/types.ts#L61"},"signature":["{ disconnects: number; total: number; statusCodes: Record; }"]},{"id":"def-server.OpsMetrics.concurrent_connections","type":"number","label":"concurrent_connections","description":["number of current concurrent connections to the server"],"source":{"path":"src/core/server/metrics/types.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/types.ts#L63"}}],"source":{"path":"src/core/server/metrics/types.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/types.ts#L51"},"initialIsOpen":false},{"id":"def-server.OpsOsMetrics","type":"Interface","label":"OpsOsMetrics","description":["\nOS related metrics"],"children":[{"id":"def-server.OpsOsMetrics.platform","type":"CompoundType","label":"platform","description":["The os platform"],"source":{"path":"src/core/server/metrics/collectors/types.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L50"},"signature":["NodeJS.Platform"]},{"id":"def-server.OpsOsMetrics.platformRelease","type":"string","label":"platformRelease","description":["The os platform release, prefixed by the platform name"],"source":{"path":"src/core/server/metrics/collectors/types.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L52"}},{"id":"def-server.OpsOsMetrics.distro","type":"string","label":"distro","description":["The os distrib. Only present for linux platforms"],"source":{"path":"src/core/server/metrics/collectors/types.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L54"},"signature":["string | undefined"]},{"id":"def-server.OpsOsMetrics.distroRelease","type":"string","label":"distroRelease","description":["The os distrib release, prefixed by the os distrib. Only present for linux platforms"],"source":{"path":"src/core/server/metrics/collectors/types.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L56"},"signature":["string | undefined"]},{"id":"def-server.OpsOsMetrics.load","type":"Object","label":"load","description":["cpu load metrics"],"source":{"path":"src/core/server/metrics/collectors/types.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L58"},"signature":["{ '1m': number; '5m': number; '15m': number; }"]},{"id":"def-server.OpsOsMetrics.memory","type":"Object","label":"memory","description":["system memory usage metrics"],"source":{"path":"src/core/server/metrics/collectors/types.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L67"},"signature":["{ total_in_bytes: number; free_in_bytes: number; used_in_bytes: number; }"]},{"id":"def-server.OpsOsMetrics.uptime_in_millis","type":"number","label":"uptime_in_millis","description":["the OS uptime"],"source":{"path":"src/core/server/metrics/collectors/types.ts","lineNumber":76,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L76"}},{"id":"def-server.OpsOsMetrics.cpuacct","type":"Object","label":"cpuacct","description":["cpu accounting metrics, undefined when not running in a cgroup"],"source":{"path":"src/core/server/metrics/collectors/types.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L79"},"signature":["{ control_group: string; usage_nanos: number; } | undefined"]},{"id":"def-server.OpsOsMetrics.cpu","type":"Object","label":"cpu","description":["cpu cgroup metrics, undefined when not running in a cgroup"],"source":{"path":"src/core/server/metrics/collectors/types.ts","lineNumber":87,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L87"},"signature":["{ control_group: string; cfs_period_micros: number; cfs_quota_micros: number; stat: { number_of_elapsed_periods: number; number_of_times_throttled: number; time_throttled_nanos: number; }; } | undefined"]}],"source":{"path":"src/core/server/metrics/collectors/types.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L48"},"initialIsOpen":false},{"id":"def-server.OpsServerMetrics","type":"Interface","label":"OpsServerMetrics","description":["\nserver related metrics"],"children":[{"id":"def-server.OpsServerMetrics.response_times","type":"Object","label":"response_times","description":["server response time stats"],"source":{"path":"src/core/server/metrics/collectors/types.ts","lineNumber":112,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L112"},"signature":["{ avg_in_millis: number; max_in_millis: number; }"]},{"id":"def-server.OpsServerMetrics.requests","type":"Object","label":"requests","description":["server requests stats"],"source":{"path":"src/core/server/metrics/collectors/types.ts","lineNumber":119,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L119"},"signature":["{ disconnects: number; total: number; statusCodes: Record; }"]},{"id":"def-server.OpsServerMetrics.concurrent_connections","type":"number","label":"concurrent_connections","description":["number of current concurrent connections to the server"],"source":{"path":"src/core/server/metrics/collectors/types.ts","lineNumber":128,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L128"}}],"source":{"path":"src/core/server/metrics/collectors/types.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L110"},"initialIsOpen":false},{"id":"def-server.OpsProcessMetrics","type":"Interface","label":"OpsProcessMetrics","description":["\nProcess related metrics"],"children":[{"id":"def-server.OpsProcessMetrics.memory","type":"Object","label":"memory","description":["process memory usage"],"source":{"path":"src/core/server/metrics/collectors/types.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L23"},"signature":["{ heap: { total_in_bytes: number; used_in_bytes: number; size_limit: number; }; resident_set_size_in_bytes: number; }"]},{"id":"def-server.OpsProcessMetrics.event_loop_delay","type":"number","label":"event_loop_delay","description":["node event loop delay"],"source":{"path":"src/core/server/metrics/collectors/types.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L37"}},{"id":"def-server.OpsProcessMetrics.pid","type":"number","label":"pid","description":["pid of the kibana process"],"source":{"path":"src/core/server/metrics/collectors/types.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L39"}},{"id":"def-server.OpsProcessMetrics.uptime_in_millis","type":"number","label":"uptime_in_millis","description":["uptime of the kibana process"],"source":{"path":"src/core/server/metrics/collectors/types.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L41"}}],"source":{"path":"src/core/server/metrics/collectors/types.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/collectors/types.ts#L21"},"initialIsOpen":false},{"id":"def-server.MetricsServiceSetup","type":"Interface","label":"MetricsServiceSetup","description":["\nAPIs to retrieves metrics gathered and exposed by the core platform.\n"],"children":[{"id":"def-server.MetricsServiceSetup.collectionInterval","type":"number","label":"collectionInterval","description":["Interval metrics are collected in milliseconds"],"source":{"path":"src/core/server/metrics/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/types.ts#L19"}},{"id":"def-server.MetricsServiceSetup.getOpsMetrics$","type":"Function","label":"getOpsMetrics$","description":["\nRetrieve an observable emitting the {@link OpsMetrics} gathered.\nThe observable will emit an initial value during core's `start` phase, and a new value every fixed interval of time,\nbased on the `opts.interval` configuration property.\n"],"source":{"path":"src/core/server/metrics/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/types.ts#L33"},"signature":["() => ","Observable","<",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.OpsMetrics","text":"OpsMetrics"},">"]}],"source":{"path":"src/core/server/metrics/types.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/types.ts#L17"},"initialIsOpen":false},{"id":"def-server.I18nServiceSetup","type":"Interface","label":"I18nServiceSetup","description":[],"children":[{"id":"def-server.I18nServiceSetup.getLocale","type":"Function","label":"getLocale","signature":["() => string"],"description":["\nReturn the locale currently in use."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/server/i18n/i18n_service.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/i18n/i18n_service.ts#L31"}},{"id":"def-server.I18nServiceSetup.getTranslationFiles","type":"Function","label":"getTranslationFiles","signature":["() => string[]"],"description":["\nReturn the absolute paths to translation files currently in use."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/server/i18n/i18n_service.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/i18n/i18n_service.ts#L36"}}],"source":{"path":"src/core/server/i18n/i18n_service.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/i18n/i18n_service.ts#L27"},"initialIsOpen":false},{"id":"def-server.AppCategory","type":"Interface","label":"AppCategory","description":["\n\nA category definition for nav links to know where to sort them in the left hand nav"],"children":[{"id":"def-server.AppCategory.id","type":"string","label":"id","description":["\nUnique identifier for the categories"],"source":{"path":"src/core/types/app_category.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L19"}},{"id":"def-server.AppCategory.label","type":"string","label":"label","description":["\nLabel used for category name.\nAlso used as aria-label if one isn't set."],"source":{"path":"src/core/types/app_category.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L25"}},{"id":"def-server.AppCategory.ariaLabel","type":"string","label":"ariaLabel","description":["\nIf the visual label isn't appropriate for screen readers,\ncan override it here"],"source":{"path":"src/core/types/app_category.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L31"},"signature":["string | undefined"]},{"id":"def-server.AppCategory.order","type":"number","label":"order","description":["\nThe order that categories will be sorted in\nPrefer large steps between categories to allow for further editing\n(Default categories are in steps of 1000)"],"source":{"path":"src/core/types/app_category.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L38"},"signature":["number | undefined"]},{"id":"def-server.AppCategory.euiIconType","type":"string","label":"euiIconType","description":["\nDefine an icon to be used for the category\nIf the category is only 1 item, and no icon is defined, will default to the product icon\nDefaults to initials if no icon is defined"],"source":{"path":"src/core/types/app_category.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L45"},"signature":["string | undefined"]}],"source":{"path":"src/core/types/app_category.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/app_category.ts#L15"},"initialIsOpen":false},{"id":"def-server.SavedObject","type":"Interface","label":"SavedObject","signature":["SavedObject",""],"description":[],"children":[{"id":"def-server.SavedObject.id","type":"string","label":"id","description":["The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`"],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L71"}},{"id":"def-server.SavedObject.type","type":"string","label":"type","description":[" The type of Saved Object. Each plugin can define it's own custom Saved Object types."],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L73"}},{"id":"def-server.SavedObject.version","type":"string","label":"version","description":["An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control."],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L75"},"signature":["string | undefined"]},{"id":"def-server.SavedObject.updated_at","type":"string","label":"updated_at","description":["Timestamp of the last time this document had been updated."],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L77"},"signature":["string | undefined"]},{"id":"def-server.SavedObject.error","type":"Object","label":"error","description":[],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L78"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectError","text":"SavedObjectError"}," | undefined"]},{"id":"def-server.SavedObject.attributes","type":"Uncategorized","label":"attributes","description":["{@inheritdoc SavedObjectAttributes}"],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L80"},"signature":["T"]},{"id":"def-server.SavedObject.references","type":"Array","label":"references","description":["{@inheritdoc SavedObjectReference}"],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L82"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[]"]},{"id":"def-server.SavedObject.migrationVersion","type":"Object","label":"migrationVersion","description":["{@inheritdoc SavedObjectsMigrationVersion}"],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L84"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectsMigrationVersion","text":"SavedObjectsMigrationVersion"}," | undefined"]},{"id":"def-server.SavedObject.coreMigrationVersion","type":"string","label":"coreMigrationVersion","description":["A semver value that is used when upgrading objects between Kibana versions."],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L86"},"signature":["string | undefined"]},{"id":"def-server.SavedObject.namespaces","type":"Array","label":"namespaces","description":["Namespace(s) that this saved object exists in. This attribute is only used for multi-namespace saved object types."],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L88"},"signature":["string[] | undefined"]},{"id":"def-server.SavedObject.originId","type":"string","label":"originId","description":["\nThe ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration\nfrom a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import\nto ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given\nspace."],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L95"},"signature":["string | undefined"]}],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L69"},"initialIsOpen":false},{"id":"def-server.SavedObjectAttributes","type":"Interface","label":"SavedObjectAttributes","description":["\nThe data for a Saved Object is stored as an object in the `attributes`\nproperty.\n"],"children":[{"id":"def-server.SavedObjectAttributes.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L36"},"signature":["any"]}],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L35"},"initialIsOpen":false},{"id":"def-server.SavedObjectReference","type":"Interface","label":"SavedObjectReference","description":["\nA reference to another saved object.\n"],"children":[{"id":"def-server.SavedObjectReference.name","type":"string","label":"name","description":[],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L45"}},{"id":"def-server.SavedObjectReference.type","type":"string","label":"type","description":[],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L46"}},{"id":"def-server.SavedObjectReference.id","type":"string","label":"id","description":[],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L47"}}],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L44"},"initialIsOpen":false},{"id":"def-server.SavedObjectsMigrationVersion","type":"Interface","label":"SavedObjectsMigrationVersion","description":["\nInformation about the migrations that have been applied to this SavedObject.\nWhen Kibana starts up, KibanaMigrator detects outdated documents and\nmigrates them based on this value. For each migration that has been applied,\nthe plugin's name is used as a key and the latest migration version as the\nvalue.\n"],"children":[{"id":"def-server.SavedObjectsMigrationVersion.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L66"},"signature":["any"]}],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L65"},"initialIsOpen":false},{"id":"def-server.LegacyServiceSetupDeps","type":"Interface","label":"LegacyServiceSetupDeps","description":[],"children":[{"id":"def-server.LegacyServiceSetupDeps.core","type":"CompoundType","label":"core","description":[],"source":{"path":"src/core/server/legacy/types.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L43"},"signature":["LegacyCoreSetup"]},{"id":"def-server.LegacyServiceSetupDeps.plugins","type":"Object","label":"plugins","description":[],"source":{"path":"src/core/server/legacy/types.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L44"},"signature":["Record"]},{"id":"def-server.LegacyServiceSetupDeps.uiPlugins","type":"Object","label":"uiPlugins","description":[],"source":{"path":"src/core/server/legacy/types.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L45"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.UiPlugins","text":"UiPlugins"}]}],"source":{"path":"src/core/server/legacy/types.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L42"},"initialIsOpen":false},{"id":"def-server.LegacyServiceStartDeps","type":"Interface","label":"LegacyServiceStartDeps","description":[],"children":[{"id":"def-server.LegacyServiceStartDeps.core","type":"CompoundType","label":"core","description":[],"source":{"path":"src/core/server/legacy/types.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L53"},"signature":["LegacyCoreStart"]},{"id":"def-server.LegacyServiceStartDeps.plugins","type":"Object","label":"plugins","description":[],"source":{"path":"src/core/server/legacy/types.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L54"},"signature":["Record"]}],"source":{"path":"src/core/server/legacy/types.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L52"},"initialIsOpen":false},{"id":"def-server.LegacyConfig","type":"Interface","label":"LegacyConfig","description":["\nNew platform representation of the legacy configuration (KibanaConfig)\n"],"children":[{"id":"def-server.LegacyConfig.get","type":"Function","label":"get","signature":["(key?: string | undefined) => T"],"description":[],"children":[{"type":"string","label":"key","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"src/core/server/legacy/types.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L32"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/legacy/types.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L32"}},{"id":"def-server.LegacyConfig.has","type":"Function","label":"has","signature":["(key: string) => boolean"],"description":[],"children":[{"type":"string","label":"key","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/legacy/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L33"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/legacy/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L33"}},{"id":"def-server.LegacyConfig.set","type":"Function","label":"set","signature":["{ (key: string, value: any): void; (config: Record): void; }"],"description":[],"children":[{"type":"string","label":"key","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/legacy/types.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L34"}},{"type":"Any","label":"value","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/core/server/legacy/types.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L34"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/legacy/types.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L34"}},{"id":"def-server.LegacyConfig.set","type":"Function","label":"set","signature":["{ (key: string, value: any): void; (config: Record): void; }"],"description":[],"children":[{"type":"Object","label":"config","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/core/server/legacy/types.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L35"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/legacy/types.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L35"}}],"source":{"path":"src/core/server/legacy/types.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/legacy/types.ts#L31"},"initialIsOpen":false},{"id":"def-server.CoreStatus","type":"Interface","label":"CoreStatus","description":["\nStatus of core services.\n"],"children":[{"id":"def-server.CoreStatus.elasticsearch","type":"Object","label":"elasticsearch","description":[],"source":{"path":"src/core/server/status/types.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L115"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ServiceStatus","text":"ServiceStatus"},""]},{"id":"def-server.CoreStatus.savedObjects","type":"Object","label":"savedObjects","description":[],"source":{"path":"src/core/server/status/types.ts","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L116"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ServiceStatus","text":"ServiceStatus"},""]}],"source":{"path":"src/core/server/status/types.ts","lineNumber":114,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L114"},"initialIsOpen":false},{"id":"def-server.ServiceStatus","type":"Interface","label":"ServiceStatus","signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ServiceStatus","text":"ServiceStatus"},""],"description":["\nThe current status of a service at a point in time.\n"],"children":[{"id":"def-server.ServiceStatus.level","type":"CompoundType","label":"level","description":["\nThe current availability level of the service."],"source":{"path":"src/core/server/status/types.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L24"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ServiceStatusLevel","text":"ServiceStatusLevel"}]},{"id":"def-server.ServiceStatus.summary","type":"string","label":"summary","description":["\nA high-level summary of the service status."],"source":{"path":"src/core/server/status/types.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L28"}},{"id":"def-server.ServiceStatus.detail","type":"string","label":"detail","description":["\nA more detailed description of the service status."],"source":{"path":"src/core/server/status/types.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L32"},"signature":["string | undefined"]},{"id":"def-server.ServiceStatus.documentationUrl","type":"string","label":"documentationUrl","description":["\nA URL to open in a new tab about how to resolve or troubleshoot the problem."],"source":{"path":"src/core/server/status/types.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L36"},"signature":["string | undefined"]},{"id":"def-server.ServiceStatus.meta","type":"Uncategorized","label":"meta","description":["\nAny JSON-serializable data to be included in the HTTP API response. Useful for providing more fine-grained,\nmachine-readable information about the service status. May include status information for underlying features."],"source":{"path":"src/core/server/status/types.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L41"},"signature":["Meta | undefined"]}],"source":{"path":"src/core/server/status/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L20"},"initialIsOpen":false},{"id":"def-server.StatusServiceSetup","type":"Interface","label":"StatusServiceSetup","description":["\nAPI for accessing status of Core and this plugin's dependencies as well as for customizing this plugin's status.\n"],"children":[{"id":"def-server.StatusServiceSetup.core$","type":"Object","label":"core$","description":["\nCurrent status for all Core services."],"source":{"path":"src/core/server/status/types.ts","lineNumber":181,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L181"},"signature":["Observable","<",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreStatus","text":"CoreStatus"},">"]},{"id":"def-server.StatusServiceSetup.overall$","type":"Object","label":"overall$","description":["\nOverall system status for all of Kibana.\n"],"source":{"path":"src/core/server/status/types.ts","lineNumber":192,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L192"},"signature":["Observable","<",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ServiceStatus","text":"ServiceStatus"},">"]},{"id":"def-server.StatusServiceSetup.set","type":"Function","label":"set","signature":["(status$: ","Observable","<",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ServiceStatus","text":"ServiceStatus"},">) => void"],"description":["\nAllows a plugin to specify a custom status dependent on its own criteria.\nCompletely overrides the default inherited status.\n"],"children":[{"type":"Object","label":"status$","isRequired":true,"signature":["Observable","<",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ServiceStatus","text":"ServiceStatus"},">"],"description":[],"source":{"path":"src/core/server/status/types.ts","lineNumber":202,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L202"}}],"tags":["remarks"],"returnComment":[],"source":{"path":"src/core/server/status/types.ts","lineNumber":202,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L202"}},{"id":"def-server.StatusServiceSetup.dependencies$","type":"Object","label":"dependencies$","description":["\nCurrent status for all plugins this plugin depends on.\nEach key of the `Record` is a plugin id."],"source":{"path":"src/core/server/status/types.ts","lineNumber":208,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L208"},"signature":["Observable",">>"]},{"id":"def-server.StatusServiceSetup.derivedStatus$","type":"Object","label":"derivedStatus$","description":["\nThe status of this plugin as derived from its dependencies.\n"],"source":{"path":"src/core/server/status/types.ts","lineNumber":220,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L220"},"signature":["Observable","<",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ServiceStatus","text":"ServiceStatus"},">"]},{"id":"def-server.StatusServiceSetup.isStatusPageAnonymous","type":"Function","label":"isStatusPageAnonymous","description":["\nWhether or not the status HTTP APIs are available to unauthenticated users when an authentication provider is\npresent."],"source":{"path":"src/core/server/status/types.ts","lineNumber":226,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L226"},"signature":["() => boolean"]}],"source":{"path":"src/core/server/status/types.ts","lineNumber":177,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L177"},"initialIsOpen":false},{"id":"def-server.CoreUsageDataStart","type":"Interface","label":"CoreUsageDataStart","description":["\nInternal API for getting Core's usage data payload.\n"],"children":[{"id":"def-server.CoreUsageDataStart.getCoreUsageData","type":"Function","label":"getCoreUsageData","signature":["() => Promise<",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreUsageData","text":"CoreUsageData"},">"],"description":["\nInternal API for getting Core's usage data payload.\n"],"children":[],"tags":["note","internal"],"returnComment":[],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":265,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L265"}}],"source":{"path":"src/core/server/core_usage_data/types.ts","lineNumber":256,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_usage_data/types.ts#L256"},"initialIsOpen":false},{"id":"def-server.RequestHandlerContext","type":"Interface","label":"RequestHandlerContext","description":["\nPlugin specific context passed to a route handler.\n\nProvides the following clients and services:\n - {@link SavedObjectsClient | savedObjects.client} - Saved Objects client\n which uses the credentials of the incoming request\n - {@link ISavedObjectTypeRegistry | savedObjects.typeRegistry} - Type registry containing\n all the registered types.\n - {@link IScopedClusterClient | elasticsearch.client} - Elasticsearch\n data client which uses the credentials of the incoming request\n - {@link LegacyScopedClusterClient | elasticsearch.legacy.client} - The legacy Elasticsearch\n data client which uses the credentials of the incoming request\n - {@link IUiSettingsClient | uiSettings.client} - uiSettings client\n which uses the credentials of the incoming request\n"],"children":[{"id":"def-server.RequestHandlerContext.core","type":"Object","label":"core","description":[],"source":{"path":"src/core/server/index.ts","lineNumber":415,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L415"},"signature":["{ savedObjects: { client: Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">; typeRegistry: Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectTypeRegistry","text":"SavedObjectTypeRegistry"},", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">; getClient: (options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClientProviderOptions","text":"SavedObjectsClientProviderOptions"}," | undefined) => Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">; getExporter: (client: Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"}]}],"source":{"path":"src/core/server/index.ts","lineNumber":414,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L414"},"initialIsOpen":false},{"id":"def-server.CoreSetup","type":"Interface","label":"CoreSetup","signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreSetup","text":"CoreSetup"},""],"description":["\nContext passed to the plugins `setup` method.\n"],"children":[{"id":"def-server.CoreSetup.capabilities","type":"Object","label":"capabilities","description":["{@link CapabilitiesSetup}"],"source":{"path":"src/core/server/index.ts","lineNumber":449,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L449"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CapabilitiesSetup","text":"CapabilitiesSetup"}]},{"id":"def-server.CoreSetup.context","type":"Object","label":"context","description":["{@link ContextSetup}"],"source":{"path":"src/core/server/index.ts","lineNumber":451,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L451"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ContextSetup","text":"ContextSetup"}]},{"id":"def-server.CoreSetup.elasticsearch","type":"Object","label":"elasticsearch","description":["{@link ElasticsearchServiceSetup}"],"source":{"path":"src/core/server/index.ts","lineNumber":453,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L453"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ElasticsearchServiceSetup","text":"ElasticsearchServiceSetup"}]},{"id":"def-server.CoreSetup.http","type":"CompoundType","label":"http","description":["{@link HttpServiceSetup}"],"source":{"path":"src/core/server/index.ts","lineNumber":455,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L455"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.HttpServiceSetup","text":"HttpServiceSetup"}," & { resources: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.HttpResources","text":"HttpResources"},"; }"]},{"id":"def-server.CoreSetup.i18n","type":"Object","label":"i18n","description":["{@link I18nServiceSetup}"],"source":{"path":"src/core/server/index.ts","lineNumber":460,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L460"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.I18nServiceSetup","text":"I18nServiceSetup"}]},{"id":"def-server.CoreSetup.logging","type":"Object","label":"logging","description":["{@link LoggingServiceSetup}"],"source":{"path":"src/core/server/index.ts","lineNumber":462,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L462"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.LoggingServiceSetup","text":"LoggingServiceSetup"}]},{"id":"def-server.CoreSetup.metrics","type":"Object","label":"metrics","description":["{@link MetricsServiceSetup}"],"source":{"path":"src/core/server/index.ts","lineNumber":464,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L464"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.MetricsServiceSetup","text":"MetricsServiceSetup"}]},{"id":"def-server.CoreSetup.savedObjects","type":"Object","label":"savedObjects","description":["{@link SavedObjectsServiceSetup}"],"source":{"path":"src/core/server/index.ts","lineNumber":466,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L466"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsServiceSetup","text":"SavedObjectsServiceSetup"}]},{"id":"def-server.CoreSetup.status","type":"Object","label":"status","description":["{@link StatusServiceSetup}"],"source":{"path":"src/core/server/index.ts","lineNumber":468,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L468"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.StatusServiceSetup","text":"StatusServiceSetup"}]},{"id":"def-server.CoreSetup.uiSettings","type":"Object","label":"uiSettings","description":["{@link UiSettingsServiceSetup}"],"source":{"path":"src/core/server/index.ts","lineNumber":470,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L470"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.UiSettingsServiceSetup","text":"UiSettingsServiceSetup"}]},{"id":"def-server.CoreSetup.getStartServices","type":"Function","label":"getStartServices","description":["{@link StartServicesAccessor}"],"source":{"path":"src/core/server/index.ts","lineNumber":472,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L472"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.StartServicesAccessor","text":"StartServicesAccessor"},""]}],"source":{"path":"src/core/server/index.ts","lineNumber":447,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L447"},"initialIsOpen":false},{"id":"def-server.CoreStart","type":"Interface","label":"CoreStart","description":["\nContext passed to the plugins `start` method.\n"],"children":[{"id":"def-server.CoreStart.capabilities","type":"Object","label":"capabilities","description":["{@link CapabilitiesStart}"],"source":{"path":"src/core/server/index.ts","lineNumber":495,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L495"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CapabilitiesStart","text":"CapabilitiesStart"}]},{"id":"def-server.CoreStart.elasticsearch","type":"Object","label":"elasticsearch","description":["{@link ElasticsearchServiceStart}"],"source":{"path":"src/core/server/index.ts","lineNumber":497,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L497"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ElasticsearchServiceStart","text":"ElasticsearchServiceStart"}]},{"id":"def-server.CoreStart.http","type":"Object","label":"http","description":["{@link HttpServiceStart}"],"source":{"path":"src/core/server/index.ts","lineNumber":499,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L499"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.HttpServiceStart","text":"HttpServiceStart"}]},{"id":"def-server.CoreStart.metrics","type":"Object","label":"metrics","description":["{@link MetricsServiceStart}"],"source":{"path":"src/core/server/index.ts","lineNumber":501,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L501"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.MetricsServiceSetup","text":"MetricsServiceSetup"}]},{"id":"def-server.CoreStart.savedObjects","type":"Object","label":"savedObjects","description":["{@link SavedObjectsServiceStart}"],"source":{"path":"src/core/server/index.ts","lineNumber":503,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L503"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsServiceStart","text":"SavedObjectsServiceStart"}]},{"id":"def-server.CoreStart.uiSettings","type":"Object","label":"uiSettings","description":["{@link UiSettingsServiceStart}"],"source":{"path":"src/core/server/index.ts","lineNumber":505,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L505"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.UiSettingsServiceStart","text":"UiSettingsServiceStart"}]},{"id":"def-server.CoreStart.coreUsageData","type":"Object","label":"coreUsageData","description":[],"source":{"path":"src/core/server/index.ts","lineNumber":507,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L507"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreUsageDataStart","text":"CoreUsageDataStart"}]}],"source":{"path":"src/core/server/index.ts","lineNumber":493,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L493"},"initialIsOpen":false},{"id":"def-server.CapabilitiesSetup","type":"Interface","label":"CapabilitiesSetup","description":["\nAPIs to manage the {@link Capabilities} that will be used by the application.\n\nPlugins relying on capabilities to toggle some of their features should register them during the setup phase\nusing the `registerProvider` method.\n\nPlugins having the responsibility to restrict capabilities depending on a given context should register\ntheir capabilities switcher using the `registerSwitcher` method.\n\nRefers to the methods documentation for complete description and examples.\n"],"children":[{"id":"def-server.CapabilitiesSetup.registerProvider","type":"Function","label":"registerProvider","signature":["(provider: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CapabilitiesProvider","text":"CapabilitiesProvider"},") => void"],"description":["\nRegister a {@link CapabilitiesProvider} to be used to provide {@link Capabilities}\nwhen resolving them.\n"],"children":[{"type":"Function","label":"provider","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CapabilitiesProvider","text":"CapabilitiesProvider"}],"description":[],"source":{"path":"src/core/server/capabilities/capabilities_service.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L54"}}],"tags":["example"],"returnComment":[],"source":{"path":"src/core/server/capabilities/capabilities_service.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L54"}},{"id":"def-server.CapabilitiesSetup.registerSwitcher","type":"Function","label":"registerSwitcher","signature":["(switcher: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CapabilitiesSwitcher","text":"CapabilitiesSwitcher"},") => void"],"description":["\nRegister a {@link CapabilitiesSwitcher} to be used to change the default state\nof the {@link Capabilities} entries when resolving them.\n\nA capabilities switcher can only change the state of existing capabilities.\nCapabilities added or removed when invoking the switcher will be ignored.\n"],"children":[{"type":"Function","label":"switcher","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CapabilitiesSwitcher","text":"CapabilitiesSwitcher"}],"description":[],"source":{"path":"src/core/server/capabilities/capabilities_service.ts","lineNumber":93,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L93"}}],"tags":["example"],"returnComment":[],"source":{"path":"src/core/server/capabilities/capabilities_service.ts","lineNumber":93,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L93"}}],"source":{"path":"src/core/server/capabilities/capabilities_service.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L30"},"initialIsOpen":false},{"id":"def-server.CapabilitiesStart","type":"Interface","label":"CapabilitiesStart","description":["\nAPIs to access the application {@link Capabilities}.\n"],"children":[{"id":"def-server.CapabilitiesStart.resolveCapabilities","type":"Function","label":"resolveCapabilities","signature":["(request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},", options?: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ResolveCapabilitiesOptions","text":"ResolveCapabilitiesOptions"}," | undefined) => Promise<",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.Capabilities","text":"Capabilities"},">"],"description":["\nResolve the {@link Capabilities} to be used for given request"],"children":[{"type":"Object","label":"request","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},""],"description":[],"source":{"path":"src/core/server/capabilities/capabilities_service.ts","lineNumber":118,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L118"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ResolveCapabilitiesOptions","text":"ResolveCapabilitiesOptions"}," | undefined"],"description":[],"source":{"path":"src/core/server/capabilities/capabilities_service.ts","lineNumber":119,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L119"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/capabilities/capabilities_service.ts","lineNumber":117,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L117"}}],"source":{"path":"src/core/server/capabilities/capabilities_service.ts","lineNumber":113,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/capabilities_service.ts#L113"},"initialIsOpen":false},{"id":"def-server.ContextSetup","type":"Interface","label":"ContextSetup","description":["\n{@inheritdoc IContextContainer}\n"],"children":[{"id":"def-server.ContextSetup.createContextContainer","type":"Function","label":"createContextContainer","signature":[">() => ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.IContextContainer","text":"IContextContainer"},""],"description":["\nCreates a new {@link IContextContainer} for a service owner."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/server/context/context_service.ts","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/context/context_service.ts#L96"}}],"source":{"path":"src/core/server/context/context_service.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/context/context_service.ts#L92"},"initialIsOpen":false},{"id":"def-server.HttpResources","type":"Interface","label":"HttpResources","description":["\nHttpResources service is responsible for serving static & dynamic assets for Kibana application via HTTP.\nProvides API allowing plug-ins to respond with:\n- a pre-configured HTML page bootstrapping Kibana client app\n- custom HTML page\n- custom JS script file."],"children":[{"id":"def-server.HttpResources.register","type":"Function","label":"register","description":["To register a route handler executing passed function to form response."],"source":{"path":"src/core/server/http_resources/types.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http_resources/types.ts#L101"},"signature":["(route: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RouteConfig","text":"RouteConfig"},", handler: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RequestHandler","text":"RequestHandler"}," | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ","Stream"]}],"source":{"path":"src/core/server/http_resources/types.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http_resources/types.ts#L99"},"initialIsOpen":false},{"id":"def-server.PluginsServiceSetup","type":"Interface","label":"PluginsServiceSetup","description":[],"children":[{"id":"def-server.PluginsServiceSetup.initialized","type":"boolean","label":"initialized","description":["Indicates whether or not plugins were initialized."],"source":{"path":"src/core/server/plugins/plugins_service.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/plugins_service.ts#L29"}},{"id":"def-server.PluginsServiceSetup.contracts","type":"Object","label":"contracts","description":["Setup contracts returned by plugins."],"source":{"path":"src/core/server/plugins/plugins_service.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/plugins_service.ts#L31"},"signature":["Map"]}],"source":{"path":"src/core/server/plugins/plugins_service.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/plugins_service.ts#L27"},"initialIsOpen":false},{"id":"def-server.PluginsServiceStart","type":"Interface","label":"PluginsServiceStart","description":[],"children":[{"id":"def-server.PluginsServiceStart.contracts","type":"Object","label":"contracts","description":["Start contracts returned by plugins."],"source":{"path":"src/core/server/plugins/plugins_service.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/plugins_service.ts#L56"},"signature":["Map"]}],"source":{"path":"src/core/server/plugins/plugins_service.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/plugins_service.ts#L54"},"initialIsOpen":false},{"id":"def-server.LegacyCallAPIOptions","type":"Interface","label":"LegacyCallAPIOptions","description":["\nThe set of options that defines how API call should be made and result be\nprocessed.\n"],"children":[{"id":"def-server.LegacyCallAPIOptions.wrap401Errors","type":"CompoundType","label":"wrap401Errors","description":["\nIndicates whether `401 Unauthorized` errors returned from the Elasticsearch API\nshould be wrapped into `Boom` error instances with properly set `WWW-Authenticate`\nheader that could have been returned by the API itself. If API didn't specify that\nthen `Basic realm=\"Authorization Required\"` is used as `WWW-Authenticate`."],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":151,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L151"},"signature":["boolean | undefined"]},{"id":"def-server.LegacyCallAPIOptions.signal","type":"Object","label":"signal","description":["\nA signal object that allows you to abort the request via an AbortController object."],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":155,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L155"},"signature":["AbortSignal | undefined"]}],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":144,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L144"},"initialIsOpen":false},{"id":"def-server.AssistantAPIClientParams","type":"Interface","label":"AssistantAPIClientParams","signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.AssistantAPIClientParams","text":"AssistantAPIClientParams"}," extends ","GenericParams"],"description":[],"children":[{"id":"def-server.AssistantAPIClientParams.path","type":"string","label":"path","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":318,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L318"},"signature":["\"/_migration/assistance\""]},{"id":"def-server.AssistantAPIClientParams.method","type":"string","label":"method","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":319,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L319"},"signature":["\"GET\""]}],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":317,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L317"},"initialIsOpen":false},{"id":"def-server.AssistanceAPIResponse","type":"Interface","label":"AssistanceAPIResponse","description":[],"children":[{"id":"def-server.AssistanceAPIResponse.indices","type":"Object","label":"indices","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":338,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L338"},"signature":["{ [indexName: string]: { action_required: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.MIGRATION_ASSISTANCE_INDEX_ACTION","text":"MIGRATION_ASSISTANCE_INDEX_ACTION"},"; }; }"]}],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":337,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L337"},"initialIsOpen":false},{"id":"def-server.DeprecationAPIClientParams","type":"Interface","label":"DeprecationAPIClientParams","signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.DeprecationAPIClientParams","text":"DeprecationAPIClientParams"}," extends ","GenericParams"],"description":[],"children":[{"id":"def-server.DeprecationAPIClientParams.path","type":"string","label":"path","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":350,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L350"},"signature":["\"/_migration/deprecations\""]},{"id":"def-server.DeprecationAPIClientParams.method","type":"string","label":"method","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":351,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L351"},"signature":["\"GET\""]}],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":349,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L349"},"initialIsOpen":false},{"id":"def-server.DeprecationInfo","type":"Interface","label":"DeprecationInfo","description":[],"children":[{"id":"def-server.DeprecationInfo.level","type":"CompoundType","label":"level","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":359,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L359"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.MIGRATION_DEPRECATION_LEVEL","text":"MIGRATION_DEPRECATION_LEVEL"}]},{"id":"def-server.DeprecationInfo.message","type":"string","label":"message","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":360,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L360"}},{"id":"def-server.DeprecationInfo.url","type":"string","label":"url","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":361,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L361"}},{"id":"def-server.DeprecationInfo.details","type":"string","label":"details","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":362,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L362"},"signature":["string | undefined"]}],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":358,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L358"},"initialIsOpen":false},{"id":"def-server.IndexSettingsDeprecationInfo","type":"Interface","label":"IndexSettingsDeprecationInfo","description":[],"children":[{"id":"def-server.IndexSettingsDeprecationInfo.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":370,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L370"},"signature":["any"]}],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":369,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L369"},"initialIsOpen":false},{"id":"def-server.DeprecationAPIResponse","type":"Interface","label":"DeprecationAPIResponse","description":[],"children":[{"id":"def-server.DeprecationAPIResponse.cluster_settings","type":"Array","label":"cluster_settings","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":378,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L378"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.DeprecationInfo","text":"DeprecationInfo"},"[]"]},{"id":"def-server.DeprecationAPIResponse.ml_settings","type":"Array","label":"ml_settings","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":379,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L379"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.DeprecationInfo","text":"DeprecationInfo"},"[]"]},{"id":"def-server.DeprecationAPIResponse.node_settings","type":"Array","label":"node_settings","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":380,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L380"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.DeprecationInfo","text":"DeprecationInfo"},"[]"]},{"id":"def-server.DeprecationAPIResponse.index_settings","type":"Object","label":"index_settings","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":381,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L381"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.IndexSettingsDeprecationInfo","text":"IndexSettingsDeprecationInfo"}]}],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":377,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L377"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-server.CapabilitiesProvider","type":"Type","label":"CapabilitiesProvider","description":["\nSee {@link CapabilitiesSetup}"],"source":{"path":"src/core/server/capabilities/types.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/types.ts#L18"},"signature":["() => Partial<","Capabilities",">"],"initialIsOpen":false},{"id":"def-server.CapabilitiesSwitcher","type":"Type","label":"CapabilitiesSwitcher","description":["\nSee {@link CapabilitiesSetup}"],"source":{"path":"src/core/server/capabilities/types.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/capabilities/types.ts#L24"},"signature":["(request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},", uiCapabilities: ","Capabilities",", useDefaultCapabilities: boolean) => Partial<","Capabilities","> | Promise>"],"initialIsOpen":false},{"id":"def-server.ConfigPath","type":"Type","label":"ConfigPath","description":[],"source":{"path":"node_modules/@kbn/config/target/config.d.ts","lineNumber":2,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/config.d.ts#L2"},"signature":["string | string[]"],"initialIsOpen":false},{"id":"def-server.ConfigDeprecation","type":"Type","label":"ConfigDeprecation","description":["\nConfiguration deprecation returned from {@link ConfigDeprecationProvider} that handles a single deprecation from the configuration.\n"],"source":{"path":"node_modules/@kbn/config/target/deprecation/types.d.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/deprecation/types.d.ts#L16"},"signature":["(config: Record, fromPath: string, logger: ","ConfigDeprecationLogger",") => Record"],"initialIsOpen":false},{"id":"def-server.ConfigDeprecationProvider","type":"Type","label":"ConfigDeprecationProvider","description":["\nA provider that should returns a list of {@link ConfigDeprecation}.\n\nSee {@link ConfigDeprecationFactory} for more usage examples.\n"],"source":{"path":"node_modules/@kbn/config/target/deprecation/types.d.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/deprecation/types.d.ts#L33"},"signature":["(factory: ","ConfigDeprecationFactory",") => ","ConfigDeprecation","[]"],"initialIsOpen":false},{"id":"def-server.ConfigDeprecationLogger","type":"Type","label":"ConfigDeprecationLogger","description":["\nLogger interface used when invoking a {@link ConfigDeprecation}\n"],"source":{"path":"node_modules/@kbn/config/target/deprecation/types.d.ts","lineNumber":6,"link":"https://github.com/elastic/kibana/tree/masternode_modules/@kbn/config/target/deprecation/types.d.ts#L6"},"signature":["(message: string) => void"],"initialIsOpen":false},{"id":"def-server.IContextProvider","type":"Type","label":"IContextProvider","description":["\nA function that returns a context value for a specific key of given context type.\n"],"source":{"path":"src/core/server/context/container/context.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/context/container/context.ts#L27"},"signature":["(context: Pick>, rest: [request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},", response: { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ","Stream"," | undefined>(options: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.CustomHttpResponseOptions","text":"CustomHttpResponseOptions"},") => ","KibanaResponse","; badRequest: (options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.ErrorHttpResponseOptions","text":"ErrorHttpResponseOptions"}],"initialIsOpen":false},{"id":"def-server.HandlerFunction","type":"Type","label":"HandlerFunction","description":["\nA function that accepts a context object and an optional number of additional arguments. Used for the generic types\nin {@link IContextContainer}\n"],"source":{"path":"src/core/server/context/container/context.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/context/container/context.ts#L42"},"signature":["(context: T, args: any[]) => any"],"initialIsOpen":false},{"id":"def-server.HandlerContextType","type":"Type","label":"HandlerContextType","description":["\nExtracts the type of the first argument of a {@link HandlerFunction} to represent the type of the context.\n"],"source":{"path":"src/core/server/context/container/context.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/context/container/context.ts#L49"},"signature":["T extends HandlerFunction ? U : never"],"initialIsOpen":false},{"id":"def-server.HandlerParameters","type":"Type","label":"HandlerParameters","description":["\nExtracts the types of the additional arguments of a {@link HandlerFunction}, excluding the\n{@link HandlerContextType}.\n"],"source":{"path":"src/core/server/context/container/context.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/context/container/context.ts#L59"},"signature":["T extends (context: any, ...args: infer U) => any ? U : never"],"initialIsOpen":false},{"id":"def-server.CoreId","type":"Type","label":"CoreId","description":[],"source":{"path":"src/core/server/core_context.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/core_context.ts#L13"},"signature":["symbol"],"initialIsOpen":false},{"id":"def-server.ILegacyClusterClient","type":"Type","label":"ILegacyClusterClient","description":["\nRepresents an Elasticsearch cluster API client created by the platform.\nIt allows to call API on behalf of the internal Kibana user and\nthe actual user that is derived from the request headers (via `asScoped(...)`).\n\nSee {@link LegacyClusterClient}.\n"],"source":{"path":"src/core/server/elasticsearch/legacy/cluster_client.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L83"},"signature":["{ callAsInternalUser: LegacyAPICaller; asScoped: (request?: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.FakeRequest","text":"FakeRequest"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.LegacyRequest","text":"LegacyRequest"}," | undefined) => Pick; }"],"initialIsOpen":false},{"id":"def-server.ILegacyCustomClusterClient","type":"Type","label":"ILegacyCustomClusterClient","description":["\nRepresents an Elasticsearch cluster API client created by a plugin.\nIt allows to call API on behalf of the internal Kibana user and\nthe actual user that is derived from the request headers (via `asScoped(...)`).\n\nSee {@link LegacyClusterClient}."],"source":{"path":"src/core/server/elasticsearch/legacy/cluster_client.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/cluster_client.ts#L94"},"signature":["{ close: () => void; callAsInternalUser: LegacyAPICaller; asScoped: (request?: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.FakeRequest","text":"FakeRequest"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.LegacyRequest","text":"LegacyRequest"}," | undefined) => Pick; }"],"initialIsOpen":false},{"id":"def-server.ILegacyScopedClusterClient","type":"Type","label":"ILegacyScopedClusterClient","description":["\nServes the same purpose as \"normal\" `ClusterClient` but exposes additional\n`callAsCurrentUser` method that doesn't use credentials of the Kibana internal\nuser (as `callAsInternalUser` does) to request Elasticsearch API, but rather\npasses HTTP headers extracted from the current user request to the API.\n\nSee {@link LegacyScopedClusterClient}.\n"],"source":{"path":"src/core/server/elasticsearch/legacy/scoped_cluster_client.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/scoped_cluster_client.ts#L24"},"signature":["{ callAsCurrentUser: (endpoint: string, clientParams?: Record, options?: LegacyCallAPIOptions | undefined) => Promise; callAsInternalUser: (endpoint: string, clientParams?: Record, options?: LegacyCallAPIOptions | undefined) => Promise; }"],"initialIsOpen":false},{"id":"def-server.LegacyElasticsearchClientConfig","type":"Type","label":"LegacyElasticsearchClientConfig","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/elasticsearch_client_config.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/elasticsearch_client_config.ts#L27"},"signature":["Pick & Pick & { pingTimeout?: ElasticsearchConfig['pingTimeout'] | ConfigOptions['pingTimeout']; requestTimeout?: ElasticsearchConfig['requestTimeout'] | ConfigOptions['requestTimeout']; sniffInterval?: ElasticsearchConfig['sniffInterval'] | ConfigOptions['sniffInterval']; ssl?: Partial; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"certificate\" | \"verificationMode\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }> | undefined; }"],"initialIsOpen":false},{"id":"def-server.ScopeableRequest","type":"Type","label":"ScopeableRequest","description":["\n A user credentials container.\nIt accommodates the necessary auth credentials to impersonate the current user.\n"],"source":{"path":"src/core/server/elasticsearch/types.ts","lineNumber":192,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/types.ts#L192"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.FakeRequest","text":"FakeRequest"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.LegacyRequest","text":"LegacyRequest"}],"initialIsOpen":false},{"id":"def-server.ElasticsearchClient","type":"Type","label":"ElasticsearchClient","description":["\nClient used to query the elasticsearch cluster.\n"],"source":{"path":"src/core/server/elasticsearch/client/types.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/types.ts#L22"},"signature":["Pick & { transport: { request(params: TransportRequestParams, options?: TransportRequestOptions | undefined): TransportRequestPromise; }; }"],"initialIsOpen":false},{"id":"def-server.ElasticsearchClientConfig","type":"Type","label":"ElasticsearchClientConfig","description":["\nConfiguration options to be used to create a {@link IClusterClient | cluster client} using the\n{@link ElasticsearchServiceStart.createClient | createClient API}\n"],"source":{"path":"src/core/server/elasticsearch/client/client_config.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/client/client_config.ts#L22"},"signature":["Pick & { pingTimeout?: ElasticsearchConfig['pingTimeout'] | ClientOptions['pingTimeout']; requestTimeout?: ElasticsearchConfig['requestTimeout'] | ClientOptions['requestTimeout']; ssl?: Partial; truststore: Readonly<{ path?: string | undefined; password?: string | undefined; } & {}>; alwaysPresentCertificate: boolean; }>, \"key\" | \"certificate\" | \"verificationMode\" | \"keyPassphrase\" | \"alwaysPresentCertificate\"> & { certificateAuthorities?: string[] | undefined; }> | undefined; keepAlive?: boolean | undefined; }"],"initialIsOpen":false},{"id":"def-server.HttpResourcesResponseOptions","type":"Type","label":"HttpResourcesResponseOptions","description":["\nHTTP Resources response parameters"],"source":{"path":"src/core/server/http_resources/types.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http_resources/types.ts#L37"},"signature":["HttpResponseOptions"],"initialIsOpen":false},{"id":"def-server.HttpResourcesRequestHandler","type":"Type","label":"HttpResourcesRequestHandler","description":["\nExtended version of {@link RequestHandler} having access to {@link HttpResourcesServiceToolkit}\nto respond with HTML or JS resources."],"source":{"path":"src/core/server/http_resources/types.ts","lineNumber":76,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http_resources/types.ts#L76"},"signature":["(context: Context, request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},", response: { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ","Stream"," | undefined>(options: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.CustomHttpResponseOptions","text":"CustomHttpResponseOptions"},") => ","KibanaResponse","; badRequest: (options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.ErrorHttpResponseOptions","text":"ErrorHttpResponseOptions"}],"initialIsOpen":false},{"id":"def-server.LoggerConfigType","type":"Type","label":"LoggerConfigType","description":[],"source":{"path":"src/core/server/logging/logging_config.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/logging/logging_config.ts#L59"},"signature":["{ readonly name: string; readonly level: ","LogLevelId","; readonly appenders: string[]; }"],"initialIsOpen":false},{"id":"def-server.AppenderConfigType","type":"Type","label":"AppenderConfigType","description":[],"source":{"path":"src/core/server/logging/appenders/appenders.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/logging/appenders/appenders.ts#L41"},"signature":["ConsoleAppenderConfig"," | ","FileAppenderConfig"," | ","LegacyAppenderConfig"," | ","RewriteAppenderConfig"," | ","RollingFileAppenderConfig"],"initialIsOpen":false},{"id":"def-server.PluginConfigSchema","type":"Type","label":"PluginConfigSchema","description":["\nDedicated type for plugin configuration schema.\n"],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L26"},"signature":["Type"],"initialIsOpen":false},{"id":"def-server.PluginInitializer","type":"Type","label":"PluginInitializer","description":["\nThe `plugin` export at the root of a plugin's `server` directory should conform\nto this interface.\n"],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":404,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L404"},"signature":["(core: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.PluginInitializerContext","text":"PluginInitializerContext"},") => ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.Plugin","text":"Plugin"}," | ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.AsyncPlugin","text":"AsyncPlugin"},""],"initialIsOpen":false},{"id":"def-server.PluginName","type":"Type","label":"PluginName","description":["\nDedicated type for plugin name/id that is supposed to make Map/Set/Arrays\nthat use it as a key or value more obvious.\n"],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L81"},"signature":["string"],"initialIsOpen":false},{"id":"def-server.SharedGlobalConfig","type":"Type","label":"SharedGlobalConfig","description":[],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":285,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L285"},"signature":["{ readonly kibana: Readonly<{ readonly index: string; readonly autocompleteTerminateAfter: Readonly<{ clone: () => ","Duration","; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: ","argThresholdOpts"," | undefined): string; (argThresholds?: ","argThresholdOpts"," | undefined): string; }; abs: () => ","Duration","; as: (units: ","unitOfTime"],"initialIsOpen":false},{"id":"def-server.PublicUiSettingsParams","type":"Type","label":"PublicUiSettingsParams","description":["\nA sub-set of {@link UiSettingsParams} exposed to the client-side."],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L102"},"signature":["{ type?: \"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"json\" | \"image\" | \"select\" | \"array\" | \"markdown\" | undefined; options?: string[] | undefined; description?: string | undefined; name?: string | undefined; order?: number | undefined; value?: unknown; category?: string[] | undefined; metric?: { type: UiCounterMetricType; name: string; } | undefined; optionLabels?: Record | undefined; requiresPageReload?: boolean | undefined; readonly?: boolean | undefined; sensitive?: boolean | undefined; deprecation?: DeprecationSettings | undefined; validation?: ImageValidation | StringValidationRegex | StringValidationRegexString | undefined; }"],"initialIsOpen":false},{"id":"def-server.UiSettingsType","type":"Type","label":"UiSettingsType","description":["\nUI element type to represent the settings."],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L16"},"signature":["\"string\" | \"number\" | \"boolean\" | \"undefined\" | \"color\" | \"json\" | \"image\" | \"select\" | \"array\" | \"markdown\""],"initialIsOpen":false},{"id":"def-server.StringValidation","type":"Type","label":"StringValidation","description":["\nAllows regex objects or a regex string"],"source":{"path":"src/core/types/ui_settings.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/ui_settings.ts#L108"},"signature":["StringValidationRegex"," | ","StringValidationRegexString"],"initialIsOpen":false},{"id":"def-server.MetricsServiceStart","type":"Type","label":"MetricsServiceStart","description":["\n{@inheritdoc MetricsServiceSetup}\n"],"source":{"path":"src/core/server/metrics/types.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/metrics/types.ts#L40"},"signature":["MetricsServiceSetup"],"initialIsOpen":false},{"id":"def-server.SavedObjectAttribute","type":"Type","label":"SavedObjectAttribute","description":["\nType definition for a Saved Object attribute value\n"],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L27"},"signature":["undefined | null | string | number | false | true | ","SavedObjectAttributes"," | ","SavedObjectAttributeSingle","[]"],"initialIsOpen":false},{"id":"def-server.SavedObjectAttributeSingle","type":"Type","label":"SavedObjectAttributeSingle","description":["\nDon't use this type, it's simply a helper type for {@link SavedObjectAttribute}\n"],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L14"},"signature":["undefined | null | string | number | false | true | ","SavedObjectAttributes"],"initialIsOpen":false},{"id":"def-server.ServiceStatusLevel","type":"Type","label":"ServiceStatusLevel","description":["\nA convenience type that represents the union of each value in {@link ServiceStatusLevels}."],"source":{"path":"src/core/server/status/types.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L103"},"signature":["Readonly<{ toString: () => \"critical\"; valueOf: () => 3; toJSON: () => \"critical\"; }> | Readonly<{ toString: () => \"degraded\"; valueOf: () => 1; toJSON: () => \"degraded\"; }> | Readonly<{ toString: () => \"unavailable\"; valueOf: () => 2; toJSON: () => \"unavailable\"; }> | Readonly<{ toString: () => \"available\"; valueOf: () => 0; toJSON: () => \"available\"; }>"],"initialIsOpen":false},{"id":"def-server.StartServicesAccessor","type":"Type","label":"StartServicesAccessor","description":["\nAllows plugins to get access to APIs available in start inside async handlers.\nPromise will not resolve until Core and plugin dependencies have completed `start`.\nThis should only be used inside handlers registered during `setup` that will only be executed\nafter `start` lifecycle.\n"],"source":{"path":"src/core/server/index.ts","lineNumber":483,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/index.ts#L483"},"signature":["() => Promise<[",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreStart","text":"CoreStart"},", TPluginsStart, TStart]>"],"initialIsOpen":false},{"id":"def-server.PluginOpaqueId","type":"Type","label":"PluginOpaqueId","description":[],"source":{"path":"src/core/server/plugins/types.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/plugins/types.ts#L84"},"signature":["symbol"],"initialIsOpen":false},{"id":"def-server.MIGRATION_ASSISTANCE_INDEX_ACTION","type":"Type","label":"MIGRATION_ASSISTANCE_INDEX_ACTION","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":326,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L326"},"signature":["\"upgrade\" | \"reindex\""],"initialIsOpen":false},{"id":"def-server.MIGRATION_DEPRECATION_LEVEL","type":"Type","label":"MIGRATION_DEPRECATION_LEVEL","description":[],"source":{"path":"src/core/server/elasticsearch/legacy/api_types.ts","lineNumber":331,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/elasticsearch/legacy/api_types.ts#L331"},"signature":["\"warning\" | \"none\" | \"info\" | \"critical\""],"initialIsOpen":false}],"objects":[{"id":"def-server.DEFAULT_APP_CATEGORIES","type":"Object","label":"DEFAULT_APP_CATEGORIES","description":[],"source":{"path":"src/core/utils/default_app_categories.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/utils/default_app_categories.ts#L13"},"signature":["Record"],"initialIsOpen":false},{"id":"def-server.ServiceStatusLevels","type":"Object","label":"ServiceStatusLevels","description":["\nThe current \"level\" of availability of a service.\n"],"source":{"path":"src/core/server/status/types.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/status/types.ts#L56"},"signature":["Readonly<{ available: Readonly<{ toString: () => \"available\"; valueOf: () => 0; toJSON: () => \"available\"; }>; degraded: Readonly<{ toString: () => \"degraded\"; valueOf: () => 1; toJSON: () => \"degraded\"; }>; unavailable: Readonly<{ toString: () => \"unavailable\"; valueOf: () => 2; toJSON: () => \"unavailable\"; }>; critical: Readonly<{ toString: () => \"critical\"; valueOf: () => 3; toJSON: () => \"critical\"; }>; }>"],"initialIsOpen":false}]},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]}} \ No newline at end of file diff --git a/api_docs/core.mdx b/api_docs/core.mdx new file mode 100644 index 0000000000000..f9cbc5707cd1d --- /dev/null +++ b/api_docs/core.mdx @@ -0,0 +1,32 @@ +--- +id: kibCorePluginApi +slug: /kibana-dev-docs/corePluginApi +title: core +image: https://source.unsplash.com/400x175/?github +summary: API docs for the core plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core'] +--- + +import coreObj from './core.json'; + +## Client + +### Objects + +### Classes + +### Interfaces + +### Consts, variables and types + +## Server + +### Objects + +### Classes + +### Interfaces + +### Consts, variables and types + diff --git a/api_docs/core_application.json b/api_docs/core_application.json new file mode 100644 index 0000000000000..a0aca5b1037ba --- /dev/null +++ b/api_docs/core_application.json @@ -0,0 +1 @@ +{"id":"core.application","client":{"classes":[{"id":"def-public.ScopedHistory","type":"Class","label":"ScopedHistory","description":["\nA wrapper around a `History` instance that is scoped to a particular base path of the history stack. Behaves\nsimilarly to the `basename` option except that this wrapper hides any history stack entries from outside the scope\nof this base path.\n\nThis wrapper also allows Core and Plugins to share a single underlying global `History` instance without exposing\nthe history of other applications.\n\nThe {@link ScopedHistory.createSubHistory | createSubHistory} method is particularly useful for applications that\ncontain any number of \"sub-apps\" which should not have access to the main application's history or basePath.\n"],"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.ScopedHistory","text":"ScopedHistory"}," implements ","History",""],"children":[{"id":"def-public.ScopedHistory.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"parentHistory","isRequired":true,"signature":["History",""],"description":[],"source":{"path":"src/core/public/application/scoped_history.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L59"}},{"type":"string","label":"basePath","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/public/application/scoped_history.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L59"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/application/scoped_history.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L59"}},{"id":"def-public.ScopedHistory.createSubHistory","type":"Function","children":[{"type":"string","label":"basePath","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/public/application/scoped_history.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L78"}}],"signature":["(basePath: string) => ",{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.ScopedHistory","text":"ScopedHistory"},""],"description":["\nCreates a `ScopedHistory` for a subpath of this `ScopedHistory`. Useful for applications that may have sub-apps\nthat do not need access to the containing application's history.\n"],"label":"createSubHistory","source":{"path":"src/core/public/application/scoped_history.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L77"},"returnComment":[]},{"id":"def-public.ScopedHistory.length","type":"number","label":"length","description":["\nThe number of entries in the history stack, including all entries forwards and backwards from the current location."],"source":{"path":"src/core/public/application/scoped_history.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L86"}},{"id":"def-public.ScopedHistory.location","type":"Object","label":"location","description":["\nThe current location of the history stack."],"source":{"path":"src/core/public/application/scoped_history.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L94"},"signature":["Location",""]},{"id":"def-public.ScopedHistory.action","type":"CompoundType","label":"action","description":["\nThe last action dispatched on the history stack."],"source":{"path":"src/core/public/application/scoped_history.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L102"},"signature":["Action"]},{"id":"def-public.ScopedHistory.push","type":"Function","children":[{"type":"CompoundType","label":"pathOrLocation","isRequired":true,"signature":["string | ","LocationDescriptorObject",""],"description":[],"source":{"path":"src/core/public/application/scoped_history.ts","lineNumber":114,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L114"}},{"type":"Uncategorized","label":"state","isRequired":false,"signature":["HistoryLocationState | undefined"],"description":[],"source":{"path":"src/core/public/application/scoped_history.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L115"}}],"signature":["(pathOrLocation: string | ","LocationDescriptorObject",", state?: HistoryLocationState | undefined) => void"],"description":["\nPushes a new location onto the history stack. If there are forward entries in the stack, they will be removed.\n"],"label":"push","source":{"path":"src/core/public/application/scoped_history.ts","lineNumber":113,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L113"},"returnComment":[]},{"id":"def-public.ScopedHistory.replace","type":"Function","children":[{"type":"CompoundType","label":"pathOrLocation","isRequired":true,"signature":["string | ","LocationDescriptorObject",""],"description":[],"source":{"path":"src/core/public/application/scoped_history.ts","lineNumber":132,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L132"}},{"type":"Uncategorized","label":"state","isRequired":false,"signature":["HistoryLocationState | undefined"],"description":[],"source":{"path":"src/core/public/application/scoped_history.ts","lineNumber":133,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L133"}}],"signature":["(pathOrLocation: string | ","LocationDescriptorObject",", state?: HistoryLocationState | undefined) => void"],"description":["\nReplaces the current location in the history stack. Does not remove forward or backward entries.\n"],"label":"replace","source":{"path":"src/core/public/application/scoped_history.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L131"},"returnComment":[]},{"id":"def-public.ScopedHistory.go","type":"Function","children":[{"type":"number","label":"n","isRequired":true,"signature":["number"],"description":[],"source":{"path":"src/core/public/application/scoped_history.ts","lineNumber":150,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L150"}}],"signature":["(n: number) => void"],"description":["\nSend the user forward or backwards in the history stack.\n"],"label":"go","source":{"path":"src/core/public/application/scoped_history.ts","lineNumber":150,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L150"},"returnComment":[]},{"id":"def-public.ScopedHistory.goBack","type":"Function","children":[],"signature":["() => void"],"description":["\nSend the user one location back in the history stack. Equivalent to calling\n{@link ScopedHistory.go | ScopedHistory.go(-1)}. If no more entries are available backwards, this is a no-op."],"label":"goBack","source":{"path":"src/core/public/application/scoped_history.ts","lineNumber":168,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L168"},"returnComment":[]},{"id":"def-public.ScopedHistory.goForward","type":"Function","children":[],"signature":["() => void"],"description":["\nSend the user one location forward in the history stack. Equivalent to calling\n{@link ScopedHistory.go | ScopedHistory.go(1)}. If no more entries are available forwards, this is a no-op."],"label":"goForward","source":{"path":"src/core/public/application/scoped_history.ts","lineNumber":177,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L177"},"returnComment":[]},{"id":"def-public.ScopedHistory.block","type":"Function","children":[{"type":"CompoundType","label":"prompt","isRequired":false,"signature":["string | boolean | ","History",".TransitionPromptHook | undefined"],"description":[],"source":{"path":"src/core/public/application/scoped_history.ts","lineNumber":186,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L186"}}],"signature":["(prompt?: string | boolean | ","History",".TransitionPromptHook | undefined) => ","UnregisterCallback"],"description":["\nAdd a block prompt requesting user confirmation when navigating away from the current page."],"label":"block","source":{"path":"src/core/public/application/scoped_history.ts","lineNumber":185,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L185"},"returnComment":[]},{"id":"def-public.ScopedHistory.listen","type":"Function","children":[{"type":"Function","label":"listener","isRequired":true,"signature":["(location: ","Location",", action: ","Action",") => void"],"description":[],"source":{"path":"src/core/public/application/scoped_history.ts","lineNumber":206,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L206"}}],"signature":["(listener: (location: ","Location",", action: ","Action",") => void) => ","UnregisterCallback"],"description":["\nAdds a listener for location updates.\n"],"label":"listen","source":{"path":"src/core/public/application/scoped_history.ts","lineNumber":205,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L205"},"returnComment":["an function to unsubscribe the listener."]},{"id":"def-public.ScopedHistory.createHref","type":"Function","children":[{"type":"Object","label":"location","isRequired":true,"signature":["LocationDescriptorObject",""],"description":[],"source":{"path":"src/core/public/application/scoped_history.ts","lineNumber":223,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L223"}},{"id":"def-public.ScopedHistory.createHref.{-prependBasePath = true }","type":"Object","label":"{ prependBasePath = true }","description":[],"children":[{"id":"def-public.ScopedHistory.createHref.{-prependBasePath = true }.prependBasePath","type":"CompoundType","label":"prependBasePath","description":[],"source":{"path":"src/core/public/application/scoped_history.ts","lineNumber":224,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L224"},"signature":["boolean | undefined"]}],"source":{"path":"src/core/public/application/scoped_history.ts","lineNumber":224,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L224"}}],"signature":["(location: ","LocationDescriptorObject",", { prependBasePath }?: { prependBasePath?: boolean | undefined; }) => string"],"description":["\nCreates an href (string) to the location.\nIf `prependBasePath` is true (default), it will prepend the location's path with the scoped history basePath.\n"],"label":"createHref","source":{"path":"src/core/public/application/scoped_history.ts","lineNumber":222,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L222"},"returnComment":[]}],"source":{"path":"src/core/public/application/scoped_history.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/scoped_history.ts#L34"},"initialIsOpen":false}],"functions":[],"interfaces":[{"id":"def-public.ApplicationSetup","type":"Interface","label":"ApplicationSetup","description":[],"children":[{"id":"def-public.ApplicationSetup.register","type":"Function","label":"register","signature":["(app: ",{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.App","text":"App"},") => void"],"description":["\nRegister an mountable application to the system."],"children":[{"type":"Object","label":"app","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.App","text":"App"},""],"description":["- an {@link App}"],"source":{"path":"src/core/public/application/types.ts","lineNumber":626,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L626"}}],"tags":["typeParam"],"returnComment":[],"source":{"path":"src/core/public/application/types.ts","lineNumber":626,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L626"}},{"id":"def-public.ApplicationSetup.registerAppUpdater","type":"Function","label":"registerAppUpdater","signature":["(appUpdater$: ","Observable","<",{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.AppUpdater","text":"AppUpdater"},">) => void"],"description":["\nRegister an application updater that can be used to change the {@link AppUpdatableFields} fields\nof all applications at runtime.\n\nThis is meant to be used by plugins that needs to updates the whole list of applications.\nTo only updates a specific application, use the `updater$` property of the registered application instead.\n"],"children":[{"type":"Object","label":"appUpdater$","isRequired":true,"signature":["Observable","<",{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.AppUpdater","text":"AppUpdater"},">"],"description":[],"source":{"path":"src/core/public/application/types.ts","lineNumber":655,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L655"}}],"tags":["example"],"returnComment":[],"source":{"path":"src/core/public/application/types.ts","lineNumber":655,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L655"}}],"source":{"path":"src/core/public/application/types.ts","lineNumber":620,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L620"},"initialIsOpen":false},{"id":"def-public.ApplicationStart","type":"Interface","label":"ApplicationStart","description":[],"children":[{"id":"def-public.ApplicationStart.capabilities","type":"Object","label":"capabilities","description":["\nGets the read-only capabilities."],"source":{"path":"src/core/public/application/types.ts","lineNumber":695,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L695"},"signature":["Readonly<{ [x: string]: Readonly<{ [x: string]: boolean | Readonly<{ [x: string]: boolean; }>; }>; navLinks: Readonly<{ [x: string]: boolean; }>; management: Readonly<{ [x: string]: Readonly<{ [x: string]: boolean; }>; }>; catalogue: Readonly<{ [x: string]: boolean; }>; }>"]},{"id":"def-public.ApplicationStart.applications$","type":"Object","label":"applications$","description":["\nObservable emitting the list of currently registered apps and their associated status.\n"],"source":{"path":"src/core/public/application/types.ts","lineNumber":704,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L704"},"signature":["Observable",">"]},{"id":"def-public.ApplicationStart.navigateToApp","type":"Function","label":"navigateToApp","signature":["(appId: string, options?: ",{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.NavigateToAppOptions","text":"NavigateToAppOptions"}," | undefined) => Promise"],"description":["\nNavigate to a given app\n"],"children":[{"type":"string","label":"appId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/public/application/types.ts","lineNumber":712,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L712"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.NavigateToAppOptions","text":"NavigateToAppOptions"}," | undefined"],"description":["- navigation options"],"source":{"path":"src/core/public/application/types.ts","lineNumber":712,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L712"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/application/types.ts","lineNumber":712,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L712"}},{"id":"def-public.ApplicationStart.navigateToUrl","type":"Function","label":"navigateToUrl","signature":["(url: string) => Promise"],"description":["\nNavigate to given URL in a SPA friendly way when possible (when the URL will redirect to a valid application\nwithin the current basePath).\n\nThe method resolves pathnames the same way browsers do when resolving a `` value. The provided `url` can be:\n- an absolute URL\n- an absolute path\n- a path relative to the current URL (window.location.href)\n\nIf all these criteria are true for the given URL:\n- (only for absolute URLs) The origin of the URL matches the origin of the browser's current location\n- The resolved pathname of the provided URL/path starts with the current basePath (eg. /mybasepath/s/my-space)\n- The pathname segment after the basePath matches any known application route (eg. /app// or any application's `appRoute` configuration)\n\nThen a SPA navigation will be performed using `navigateToApp` using the corresponding application and path.\nOtherwise, fallback to a full page reload to navigate to the url using `window.location.assign`\n"],"children":[{"type":"string","label":"url","isRequired":true,"signature":["string"],"description":["- an absolute URL, an absolute path or a relative path, to navigate to."],"source":{"path":"src/core/public/application/types.ts","lineNumber":750,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L750"}}],"tags":["example"],"returnComment":[],"source":{"path":"src/core/public/application/types.ts","lineNumber":750,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L750"}},{"id":"def-public.ApplicationStart.getUrlForApp","type":"Function","label":"getUrlForApp","signature":["(appId: string, options?: { path?: string | undefined; absolute?: boolean | undefined; } | undefined) => string"],"description":["\nReturns the absolute path (or URL) to a given app, including the global base path.\n\nBy default, it returns the absolute path of the application (e.g `/basePath/app/my-app`).\nUse the `absolute` option to generate an absolute url instead (e.g `http://host:port/basePath/app/my-app`)\n\nNote that when generating absolute urls, the origin (protocol, host and port) are determined from the browser's current location.\n"],"children":[{"type":"string","label":"appId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/public/application/types.ts","lineNumber":764,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L764"}},{"id":"def-public.ApplicationStart.getUrlForApp.options","type":"Object","label":"options","description":[],"children":[{"id":"def-public.ApplicationStart.getUrlForApp.options.path","type":"string","label":"path","description":[],"source":{"path":"src/core/public/application/types.ts","lineNumber":764,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L764"},"signature":["string | undefined"]},{"id":"def-public.ApplicationStart.getUrlForApp.options.absolute","type":"CompoundType","label":"absolute","description":[],"source":{"path":"src/core/public/application/types.ts","lineNumber":764,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L764"},"signature":["boolean | undefined"]}],"source":{"path":"src/core/public/application/types.ts","lineNumber":764,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L764"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/application/types.ts","lineNumber":764,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L764"}},{"id":"def-public.ApplicationStart.currentAppId$","type":"Object","label":"currentAppId$","description":["\nAn observable that emits the current application id and each subsequent id update."],"source":{"path":"src/core/public/application/types.ts","lineNumber":769,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L769"},"signature":["Observable",""]}],"source":{"path":"src/core/public/application/types.ts","lineNumber":691,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L691"},"initialIsOpen":false},{"id":"def-public.App","type":"Interface","label":"App","signature":[{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.App","text":"App"},""],"description":[],"children":[{"id":"def-public.App.id","type":"string","label":"id","description":["\nThe unique identifier of the application"],"source":{"path":"src/core/public/application/types.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L83"}},{"id":"def-public.App.title","type":"string","label":"title","description":["\nThe title of the application."],"source":{"path":"src/core/public/application/types.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L88"}},{"id":"def-public.App.category","type":"Object","label":"category","description":["\nThe category definition of the product\nSee {@link AppCategory}\nSee DEFAULT_APP_CATEGORIES for more reference"],"source":{"path":"src/core/public/application/types.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L95"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.AppCategory","text":"AppCategory"}," | undefined"]},{"id":"def-public.App.status","type":"CompoundType","label":"status","description":["\nThe initial status of the application.\nDefaulting to `accessible`"],"source":{"path":"src/core/public/application/types.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L101"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.AppStatus","text":"AppStatus"}," | undefined"]},{"id":"def-public.App.navLinkStatus","type":"CompoundType","label":"navLinkStatus","description":["\nThe initial status of the application's navLink.\nDefaulting to `visible` if `status` is `accessible` and `hidden` if status is `inaccessible`\nSee {@link AppNavLinkStatus}"],"source":{"path":"src/core/public/application/types.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L108"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.AppNavLinkStatus","text":"AppNavLinkStatus"}," | undefined"]},{"id":"def-public.App.defaultPath","type":"string","label":"defaultPath","description":["\nAllow to define the default path a user should be directed to when navigating to the app.\nWhen defined, this value will be used as a default for the `path` option when calling {@link ApplicationStart.navigateToApp | navigateToApp}`,\nand will also be appended to the {@link ChromeNavLink | application navLink} in the navigation bar."],"source":{"path":"src/core/public/application/types.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L115"},"signature":["string | undefined"]},{"id":"def-public.App.updater$","type":"Object","label":"updater$","description":["\nAn {@link AppUpdater} observable that can be used to update the application {@link AppUpdatableFields} at runtime.\n"],"source":{"path":"src/core/public/application/types.ts","lineNumber":149,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L149"},"signature":["Observable","<",{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.AppUpdater","text":"AppUpdater"},"> | undefined"]},{"id":"def-public.App.order","type":"number","label":"order","description":["\nAn ordinal used to sort nav links relative to one another for display."],"source":{"path":"src/core/public/application/types.ts","lineNumber":154,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L154"},"signature":["number | undefined"]},{"id":"def-public.App.tooltip","type":"string","label":"tooltip","description":["\nA tooltip shown when hovering over app link."],"source":{"path":"src/core/public/application/types.ts","lineNumber":159,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L159"},"signature":["string | undefined"]},{"id":"def-public.App.euiIconType","type":"string","label":"euiIconType","description":["\nA EUI iconType that will be used for the app's icon. This icon\ntakes precendence over the `icon` property."],"source":{"path":"src/core/public/application/types.ts","lineNumber":165,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L165"},"signature":["string | undefined"]},{"id":"def-public.App.icon","type":"string","label":"icon","description":["\nA URL to an image file used as an icon. Used as a fallback\nif `euiIconType` is not provided."],"source":{"path":"src/core/public/application/types.ts","lineNumber":171,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L171"},"signature":["string | undefined"]},{"id":"def-public.App.capabilities","type":"Object","label":"capabilities","description":["\nCustom capabilities defined by the app."],"source":{"path":"src/core/public/application/types.ts","lineNumber":176,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L176"},"signature":["Partial<",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.Capabilities","text":"Capabilities"},"> | undefined"]},{"id":"def-public.App.chromeless","type":"CompoundType","label":"chromeless","description":["\nHide the UI chrome when the application is mounted. Defaults to `false`.\nTakes precedence over chrome service visibility settings."],"source":{"path":"src/core/public/application/types.ts","lineNumber":182,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L182"},"signature":["boolean | undefined"]},{"id":"def-public.App.mount","type":"Function","label":"mount","description":["\nA mount function called when the user navigates to this app's route."],"source":{"path":"src/core/public/application/types.ts","lineNumber":187,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L187"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.AppMount","text":"AppMount"},""]},{"id":"def-public.App.appRoute","type":"string","label":"appRoute","description":["\nOverride the application's routing path from `/app/${id}`.\nMust be unique across registered applications. Should not include the\nbase path from HTTP."],"source":{"path":"src/core/public/application/types.ts","lineNumber":194,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L194"},"signature":["string | undefined"]},{"id":"def-public.App.exactRoute","type":"CompoundType","label":"exactRoute","description":["\nIf set to true, the application's route will only be checked against an exact match. Defaults to `false`.\n"],"source":{"path":"src/core/public/application/types.ts","lineNumber":212,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L212"},"signature":["boolean | undefined"]},{"id":"def-public.App.meta","type":"Object","label":"meta","description":["\nMeta data for an application that represent additional information for the app.\nSee {@link AppMeta}\n"],"source":{"path":"src/core/public/application/types.ts","lineNumber":244,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L244"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.AppMeta","text":"AppMeta"}," | undefined"]}],"source":{"path":"src/core/public/application/types.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L79"},"initialIsOpen":false},{"id":"def-public.AppMountParameters","type":"Interface","label":"AppMountParameters","signature":[{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.AppMountParameters","text":"AppMountParameters"},""],"description":[],"children":[{"id":"def-public.AppMountParameters.element","type":"Object","label":"element","description":["\nThe container element to render the application into."],"source":{"path":"src/core/public/application/types.ts","lineNumber":353,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L353"},"signature":["HTMLElement"]},{"id":"def-public.AppMountParameters.history","type":"Object","label":"history","description":["\nA scoped history instance for your application. Should be used to wire up\nyour applications Router.\n"],"source":{"path":"src/core/public/application/types.ts","lineNumber":399,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L399"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.ScopedHistory","text":"ScopedHistory"},""]},{"id":"def-public.AppMountParameters.appBasePath","type":"string","label":"appBasePath","description":["\nThe route path for configuring navigation to the application.\nThis string should not include the base path from HTTP.\n"],"source":{"path":"src/core/public/application/types.ts","lineNumber":449,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L449"}},{"id":"def-public.AppMountParameters.onAppLeave","type":"Function","label":"onAppLeave","description":["\nA function that can be used to register a handler that will be called\nwhen the user is leaving the current application, allowing to\nprompt a confirmation message before actually changing the page.\n\nThis will be called either when the user goes to another application, or when\ntrying to close the tab or manually changing the url.\n"],"source":{"path":"src/core/public/application/types.ts","lineNumber":484,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L484"},"signature":["(handler: ",{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.AppLeaveHandler","text":"AppLeaveHandler"},") => void"]},{"id":"def-public.AppMountParameters.setHeaderActionMenu","type":"Function","label":"setHeaderActionMenu","description":["\nA function that can be used to set the mount point used to populate the application action container\nin the chrome header.\n\nCalling the handler multiple time will erase the current content of the action menu with the mount from the latest call.\nCalling the handler with `undefined` will unmount the current mount point.\nCalling the handler after the application has been unmounted will have no effect.\n"],"source":{"path":"src/core/public/application/types.ts","lineNumber":515,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L515"},"signature":["(menuMount: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.MountPoint","text":"MountPoint"}," | undefined) => void"]}],"source":{"path":"src/core/public/application/types.ts","lineNumber":349,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L349"},"initialIsOpen":false},{"id":"def-public.AppLeaveDefaultAction","type":"Interface","label":"AppLeaveDefaultAction","description":["\nAction to return from a {@link AppLeaveHandler} to execute the default\nbehaviour when leaving the application.\n\nSee {@link AppLeaveActionFactory}\n"],"children":[{"id":"def-public.AppLeaveDefaultAction.type","type":"string","label":"type","description":[],"source":{"path":"src/core/public/application/types.ts","lineNumber":554,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L554"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.AppLeaveActionType","text":"AppLeaveActionType"},".default"]}],"source":{"path":"src/core/public/application/types.ts","lineNumber":553,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L553"},"initialIsOpen":false},{"id":"def-public.AppLeaveConfirmAction","type":"Interface","label":"AppLeaveConfirmAction","description":["\nAction to return from a {@link AppLeaveHandler} to show a confirmation\nmessage when trying to leave an application.\n\nSee {@link AppLeaveActionFactory}\n"],"children":[{"id":"def-public.AppLeaveConfirmAction.type","type":"string","label":"type","description":[],"source":{"path":"src/core/public/application/types.ts","lineNumber":566,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L566"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.AppLeaveActionType","text":"AppLeaveActionType"},".confirm"]},{"id":"def-public.AppLeaveConfirmAction.text","type":"string","label":"text","description":[],"source":{"path":"src/core/public/application/types.ts","lineNumber":567,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L567"}},{"id":"def-public.AppLeaveConfirmAction.title","type":"string","label":"title","description":[],"source":{"path":"src/core/public/application/types.ts","lineNumber":568,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L568"},"signature":["string | undefined"]},{"id":"def-public.AppLeaveConfirmAction.callback","type":"Function","label":"callback","description":[],"source":{"path":"src/core/public/application/types.ts","lineNumber":569,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L569"},"signature":["(() => void) | undefined"]}],"source":{"path":"src/core/public/application/types.ts","lineNumber":565,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L565"},"initialIsOpen":false},{"id":"def-public.AppMeta","type":"Interface","label":"AppMeta","description":["\nInput type for meta data for an application.\n\nMeta fields include `keywords` and `searchDeepLinks`\nKeywords is an array of string with which to associate the app, must include at least one unique string as an array.\n`searchDeepLinks` is an array of links that represent secondary in-app locations for the app."],"children":[{"id":"def-public.AppMeta.keywords","type":"Array","label":"keywords","description":["Keywords to represent this application"],"source":{"path":"src/core/public/application/types.ts","lineNumber":257,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L257"},"signature":["string[] | undefined"]},{"id":"def-public.AppMeta.searchDeepLinks","type":"Array","label":"searchDeepLinks","description":["Array of links that represent secondary in-app locations for the app."],"source":{"path":"src/core/public/application/types.ts","lineNumber":259,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L259"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.AppSearchDeepLink","text":"AppSearchDeepLink"},"[] | undefined"]}],"source":{"path":"src/core/public/application/types.ts","lineNumber":255,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L255"},"initialIsOpen":false},{"id":"def-public.NavigateToAppOptions","type":"Interface","label":"NavigateToAppOptions","description":["\nOptions for the {@link ApplicationStart.navigateToApp | navigateToApp API}"],"children":[{"id":"def-public.NavigateToAppOptions.path","type":"string","label":"path","description":["\noptional path inside application to deep link to.\nIf undefined, will use {@link App.defaultPath | the app's default path}` as default."],"source":{"path":"src/core/public/application/types.ts","lineNumber":679,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L679"},"signature":["string | undefined"]},{"id":"def-public.NavigateToAppOptions.state","type":"Unknown","label":"state","description":["\noptional state to forward to the application"],"source":{"path":"src/core/public/application/types.ts","lineNumber":683,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L683"},"signature":["unknown"]},{"id":"def-public.NavigateToAppOptions.replace","type":"CompoundType","label":"replace","description":["\nif true, will not create a new history entry when navigating (using `replace` instead of `push`)"],"source":{"path":"src/core/public/application/types.ts","lineNumber":687,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L687"},"signature":["boolean | undefined"]}],"source":{"path":"src/core/public/application/types.ts","lineNumber":674,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L674"},"initialIsOpen":false}],"enums":[{"id":"def-public.AppLeaveActionType","type":"Enum","label":"AppLeaveActionType","description":["\nPossible type of actions on application leave.\n"],"source":{"path":"src/core/public/application/types.ts","lineNumber":540,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L540"},"initialIsOpen":false},{"id":"def-public.AppStatus","type":"Enum","label":"AppStatus","description":["\nAccessibility status of an application.\n"],"source":{"path":"src/core/public/application/types.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L24"},"initialIsOpen":false},{"id":"def-public.AppNavLinkStatus","type":"Enum","label":"AppNavLinkStatus","description":["\nStatus of the application's navLink.\n"],"source":{"path":"src/core/public/application/types.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L40"},"initialIsOpen":false}],"misc":[{"id":"def-public.AppMount","type":"Type","label":"AppMount","description":["\nA mount function called when the user navigates to this app's route.\n"],"source":{"path":"src/core/public/application/types.ts","lineNumber":338,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L338"},"signature":["(params: ",{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.AppMountParameters","text":"AppMountParameters"},") => ",{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.AppUnmount","text":"AppUnmount"}," | Promise<",{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.AppUnmount","text":"AppUnmount"},">"],"initialIsOpen":false},{"id":"def-public.AppUnmount","type":"Type","label":"AppUnmount","description":["\nA function called when an application should be unmounted from the page. This function should be synchronous."],"source":{"path":"src/core/public/application/types.ts","lineNumber":346,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L346"},"signature":["() => void"],"initialIsOpen":false},{"id":"def-public.AppLeaveHandler","type":"Type","label":"AppLeaveHandler","description":["\nA handler that will be executed before leaving the application, either when\ngoing to another application or when closing the browser tab or manually changing\nthe url.\nShould return `confirm` to to prompt a message to the user before leaving the page, or `default`\nto keep the default behavior (doing nothing).\n\nSee {@link AppMountParameters} for detailed usage examples.\n"],"source":{"path":"src/core/public/application/types.ts","lineNumber":530,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L530"},"signature":["(factory: ","AppLeaveActionFactory",", nextAppId: string | undefined) => ",{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.AppLeaveAction","text":"AppLeaveAction"}],"initialIsOpen":false},{"id":"def-public.AppLeaveAction","type":"Type","label":"AppLeaveAction","description":["\nPossible actions to return from a {@link AppLeaveHandler}\n\nSee {@link AppLeaveConfirmAction} and {@link AppLeaveDefaultAction}\n"],"source":{"path":"src/core/public/application/types.ts","lineNumber":579,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L579"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.AppLeaveDefaultAction","text":"AppLeaveDefaultAction"}," | ",{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.AppLeaveConfirmAction","text":"AppLeaveConfirmAction"}],"initialIsOpen":false},{"id":"def-public.AppUpdatableFields","type":"Type","label":"AppUpdatableFields","description":["\nDefines the list of fields that can be updated via an {@link AppUpdater}."],"source":{"path":"src/core/public/application/types.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L64"},"signature":["{ status?: AppStatus | undefined; meta?: AppMeta | undefined; navLinkStatus?: AppNavLinkStatus | undefined; defaultPath?: string | undefined; tooltip?: string | undefined; }"],"initialIsOpen":false},{"id":"def-public.AppUpdater","type":"Type","label":"AppUpdater","description":["\nUpdater for applications.\nsee {@link ApplicationSetup}"],"source":{"path":"src/core/public/application/types.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L74"},"signature":["(app: ",{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.App","text":"App"},") => Partial, \"status\" | \"meta\" | \"navLinkStatus\" | \"defaultPath\" | \"tooltip\">> | undefined"],"initialIsOpen":false},{"id":"def-public.AppSearchDeepLink","type":"Type","label":"AppSearchDeepLink","description":["\nInput type for registering secondary in-app locations for an application.\n\nDeep links must include at least one of `path` or `searchDeepLinks`. A deep link that does not have a `path`\nrepresents a topological level in the application's hierarchy, but does not have a destination URL that is\nuser-accessible."],"source":{"path":"src/core/public/application/types.ts","lineNumber":293,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L293"},"signature":["{ id: string; title: string; } & { path: string; searchDeepLinks?: ",{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.AppSearchDeepLink","text":"AppSearchDeepLink"},"[] | undefined; keywords?: string[] | undefined; } | { id: string; title: string; } & { path?: string | undefined; searchDeepLinks: ",{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.AppSearchDeepLink","text":"AppSearchDeepLink"},"[]; keywords?: string[] | undefined; }"],"initialIsOpen":false},{"id":"def-public.PublicAppInfo","type":"Type","label":"PublicAppInfo","description":["\nPublic information about a registered {@link App | application}\n"],"source":{"path":"src/core/public/application/types.ts","lineNumber":322,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L322"},"signature":["Pick, \"status\" | \"id\" | \"title\" | \"order\" | \"category\" | \"navLinkStatus\" | \"defaultPath\" | \"tooltip\" | \"euiIconType\" | \"icon\" | \"capabilities\" | \"chromeless\" | \"appRoute\" | \"exactRoute\"> & { status: AppStatus; navLinkStatus: AppNavLinkStatus; appRoute: string; meta: PublicAppMetaInfo; }"],"initialIsOpen":false},{"id":"def-public.PublicAppMetaInfo","type":"Type","label":"PublicAppMetaInfo","description":["\nPublic information about a registered app's {@link AppMeta | keywords }\n"],"source":{"path":"src/core/public/application/types.ts","lineNumber":267,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L267"},"signature":["Pick & { keywords: string[]; searchDeepLinks: PublicAppSearchDeepLinkInfo[]; }"],"initialIsOpen":false},{"id":"def-public.PublicAppSearchDeepLinkInfo","type":"Type","label":"PublicAppSearchDeepLinkInfo","description":["\nPublic information about a registered app's {@link AppSearchDeepLink | searchDeepLinks}\n"],"source":{"path":"src/core/public/application/types.ts","lineNumber":277,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/application/types.ts#L277"},"signature":["Pick & { searchDeepLinks: PublicAppSearchDeepLinkInfo[]; keywords: string[]; }"],"initialIsOpen":false}],"objects":[]},"server":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]}} \ No newline at end of file diff --git a/api_docs/core_application.mdx b/api_docs/core_application.mdx new file mode 100644 index 0000000000000..27b01898f449e --- /dev/null +++ b/api_docs/core_application.mdx @@ -0,0 +1,22 @@ +--- +id: kibCoreApplicationPluginApi +slug: /kibana-dev-docs/core.applicationPluginApi +title: core.application +image: https://source.unsplash.com/400x175/?github +summary: API docs for the core.application plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.application'] +--- + +import coreApplicationObj from './core_application.json'; + +## Client + +### Classes + +### Interfaces + +### Enums + +### Consts, variables and types + diff --git a/api_docs/core_chrome.json b/api_docs/core_chrome.json new file mode 100644 index 0000000000000..22fb691aea0c9 --- /dev/null +++ b/api_docs/core_chrome.json @@ -0,0 +1 @@ +{"id":"core.chrome","client":{"classes":[],"functions":[],"interfaces":[{"id":"def-public.ChromeBadge","type":"Interface","label":"ChromeBadge","description":[],"children":[{"id":"def-public.ChromeBadge.text","type":"string","label":"text","description":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L20"}},{"id":"def-public.ChromeBadge.tooltip","type":"string","label":"tooltip","description":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L21"}},{"id":"def-public.ChromeBadge.iconType","type":"CompoundType","label":"iconType","description":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L22"},"signature":["string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined"]}],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L19"},"initialIsOpen":false},{"id":"def-public.ChromeBrand","type":"Interface","label":"ChromeBrand","description":[],"children":[{"id":"def-public.ChromeBrand.logo","type":"string","label":"logo","description":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L27"},"signature":["string | undefined"]},{"id":"def-public.ChromeBrand.smallLogo","type":"string","label":"smallLogo","description":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L28"},"signature":["string | undefined"]}],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L26"},"initialIsOpen":false},{"id":"def-public.ChromeHelpExtension","type":"Interface","label":"ChromeHelpExtension","description":[],"children":[{"id":"def-public.ChromeHelpExtension.appName","type":"string","label":"appName","description":["\nProvide your plugin's name to create a header for separation"],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L49"}},{"id":"def-public.ChromeHelpExtension.links","type":"Array","label":"links","description":["\nCreates unified links for sending users to documentation, GitHub, Discuss, or a custom link/button"],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L53"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeHelpExtensionMenuLink","text":"ChromeHelpExtensionMenuLink"},"[] | undefined"]},{"id":"def-public.ChromeHelpExtension.content","type":"Function","label":"content","description":["\nCustom content to occur below the list of links"],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L57"},"signature":["((element: HTMLDivElement) => () => void) | undefined"]}],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L45"},"initialIsOpen":false},{"id":"def-public.ChromeHelpExtensionMenuCustomLink","type":"Interface","label":"ChromeHelpExtensionMenuCustomLink","signature":[{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeHelpExtensionMenuCustomLink","text":"ChromeHelpExtensionMenuCustomLink"}," extends Pick<(","DisambiguateSet","<","PropsForAnchor",", ","PropsForButton","> & CommonEuiButtonEmptyProps & { onClick?: ((event: React.MouseEvent) => void) | undefined; } & React.ButtonHTMLAttributes) | (","DisambiguateSet"],"description":[],"children":[{"id":"def-public.ChromeHelpExtensionMenuCustomLink.linkType","type":"string","label":"linkType","description":["\nExtend EuiButtonEmpty to provide extra functionality"],"source":{"path":"src/core/public/chrome/ui/header/header_help_menu.tsx","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L86"},"signature":["\"custom\""]},{"id":"def-public.ChromeHelpExtensionMenuCustomLink.href","type":"string","label":"href","description":["\nURL of the link"],"source":{"path":"src/core/public/chrome/ui/header/header_help_menu.tsx","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L90"}},{"id":"def-public.ChromeHelpExtensionMenuCustomLink.content","type":"CompoundType","label":"content","description":["\nContent of the button (in lieu of `children`)"],"source":{"path":"src/core/public/chrome/ui/header/header_help_menu.tsx","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L94"},"signature":["React.ReactNode"]}],"source":{"path":"src/core/public/chrome/ui/header/header_help_menu.tsx","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L82"},"initialIsOpen":false},{"id":"def-public.ChromeHelpExtensionMenuDiscussLink","type":"Interface","label":"ChromeHelpExtensionMenuDiscussLink","signature":[{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeHelpExtensionMenuDiscussLink","text":"ChromeHelpExtensionMenuDiscussLink"}," extends Pick<(","DisambiguateSet","<","PropsForAnchor",", ","PropsForButton","> & CommonEuiButtonEmptyProps & { onClick?: ((event: React.MouseEvent) => void) | undefined; } & React.ButtonHTMLAttributes) | (","DisambiguateSet"],"description":[],"children":[{"id":"def-public.ChromeHelpExtensionMenuDiscussLink.linkType","type":"string","label":"linkType","description":["\nCreates a generic give feedback link with comment icon"],"source":{"path":"src/core/public/chrome/ui/header/header_help_menu.tsx","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L60"},"signature":["\"discuss\""]},{"id":"def-public.ChromeHelpExtensionMenuDiscussLink.href","type":"string","label":"href","description":["\nURL to discuss page.\ni.e. `https://discuss.elastic.co/c/${appName}`"],"source":{"path":"src/core/public/chrome/ui/header/header_help_menu.tsx","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L65"}}],"source":{"path":"src/core/public/chrome/ui/header/header_help_menu.tsx","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L56"},"initialIsOpen":false},{"id":"def-public.ChromeHelpExtensionMenuDocumentationLink","type":"Interface","label":"ChromeHelpExtensionMenuDocumentationLink","signature":[{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeHelpExtensionMenuDocumentationLink","text":"ChromeHelpExtensionMenuDocumentationLink"}," extends Pick<(","DisambiguateSet","<","PropsForAnchor",", ","PropsForButton","> & CommonEuiButtonEmptyProps & { onClick?: ((event: React.MouseEvent) => void) | undefined; } & React.ButtonHTMLAttributes) | (","DisambiguateSet"],"description":[],"children":[{"id":"def-public.ChromeHelpExtensionMenuDocumentationLink.linkType","type":"string","label":"linkType","description":["\nCreates a deep-link to app-specific documentation"],"source":{"path":"src/core/public/chrome/ui/header/header_help_menu.tsx","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L73"},"signature":["\"documentation\""]},{"id":"def-public.ChromeHelpExtensionMenuDocumentationLink.href","type":"string","label":"href","description":["\nURL to documentation page.\ni.e. `${ELASTIC_WEBSITE_URL}guide/en/kibana/${DOC_LINK_VERSION}/${appName}.html`,"],"source":{"path":"src/core/public/chrome/ui/header/header_help_menu.tsx","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L78"}}],"source":{"path":"src/core/public/chrome/ui/header/header_help_menu.tsx","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L69"},"initialIsOpen":false},{"id":"def-public.ChromeHelpExtensionMenuGitHubLink","type":"Interface","label":"ChromeHelpExtensionMenuGitHubLink","signature":[{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeHelpExtensionMenuGitHubLink","text":"ChromeHelpExtensionMenuGitHubLink"}," extends Pick<(","DisambiguateSet","<","PropsForAnchor",", ","PropsForButton","> & CommonEuiButtonEmptyProps & { onClick?: ((event: React.MouseEvent) => void) | undefined; } & React.ButtonHTMLAttributes) | (","DisambiguateSet"],"description":[],"children":[{"id":"def-public.ChromeHelpExtensionMenuGitHubLink.linkType","type":"string","label":"linkType","description":["\nCreates a link to a new github issue in the Kibana repo"],"source":{"path":"src/core/public/chrome/ui/header/header_help_menu.tsx","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L44"},"signature":["\"github\""]},{"id":"def-public.ChromeHelpExtensionMenuGitHubLink.labels","type":"Array","label":"labels","description":["\nInclude at least one app-specific label to be applied to the new github issue"],"source":{"path":"src/core/public/chrome/ui/header/header_help_menu.tsx","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L48"},"signature":["string[]"]},{"id":"def-public.ChromeHelpExtensionMenuGitHubLink.title","type":"string","label":"title","description":["\nProvides initial text for the title of the issue"],"source":{"path":"src/core/public/chrome/ui/header/header_help_menu.tsx","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L52"},"signature":["string | undefined"]}],"source":{"path":"src/core/public/chrome/ui/header/header_help_menu.tsx","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L40"},"initialIsOpen":false},{"id":"def-public.ChromeNavControl","type":"Interface","label":"ChromeNavControl","description":[],"children":[{"id":"def-public.ChromeNavControl.order","type":"number","label":"order","description":[],"source":{"path":"src/core/public/chrome/nav_controls/nav_controls_service.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L16"},"signature":["number | undefined"]},{"id":"def-public.ChromeNavControl.mount","type":"Function","label":"mount","description":[],"source":{"path":"src/core/public/chrome/nav_controls/nav_controls_service.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L17"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.MountPoint","text":"MountPoint"},""]}],"source":{"path":"src/core/public/chrome/nav_controls/nav_controls_service.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L15"},"initialIsOpen":false},{"id":"def-public.ChromeNavControls","type":"Interface","label":"ChromeNavControls","description":["\n{@link ChromeNavControls | APIs} for registering new controls to be displayed in the navigation bar.\n"],"children":[{"id":"def-public.ChromeNavControls.registerLeft","type":"Function","label":"registerLeft","signature":["(navControl: ",{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeNavControl","text":"ChromeNavControl"},") => void"],"description":["Register a nav control to be presented on the bottom-left side of the chrome header."],"children":[{"type":"Object","label":"navControl","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeNavControl","text":"ChromeNavControl"}],"description":[],"source":{"path":"src/core/public/chrome/nav_controls/nav_controls_service.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L38"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/chrome/nav_controls/nav_controls_service.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L38"}},{"id":"def-public.ChromeNavControls.registerRight","type":"Function","label":"registerRight","signature":["(navControl: ",{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeNavControl","text":"ChromeNavControl"},") => void"],"description":["Register a nav control to be presented on the top-right side of the chrome header."],"children":[{"type":"Object","label":"navControl","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeNavControl","text":"ChromeNavControl"}],"description":[],"source":{"path":"src/core/public/chrome/nav_controls/nav_controls_service.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L40"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/chrome/nav_controls/nav_controls_service.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L40"}},{"id":"def-public.ChromeNavControls.registerCenter","type":"Function","label":"registerCenter","signature":["(navControl: ",{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeNavControl","text":"ChromeNavControl"},") => void"],"description":["Register a nav control to be presented on the top-center side of the chrome header."],"children":[{"type":"Object","label":"navControl","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeNavControl","text":"ChromeNavControl"}],"description":[],"source":{"path":"src/core/public/chrome/nav_controls/nav_controls_service.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L42"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/chrome/nav_controls/nav_controls_service.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L42"}},{"id":"def-public.ChromeNavControls.getLeft$","type":"Function","label":"getLeft$","signature":["() => ","Observable","<",{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeNavControl","text":"ChromeNavControl"},"[]>"],"description":[],"children":[],"tags":["internal"],"returnComment":[],"source":{"path":"src/core/public/chrome/nav_controls/nav_controls_service.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L44"}},{"id":"def-public.ChromeNavControls.getRight$","type":"Function","label":"getRight$","signature":["() => ","Observable","<",{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeNavControl","text":"ChromeNavControl"},"[]>"],"description":[],"children":[],"tags":["internal"],"returnComment":[],"source":{"path":"src/core/public/chrome/nav_controls/nav_controls_service.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L46"}},{"id":"def-public.ChromeNavControls.getCenter$","type":"Function","label":"getCenter$","signature":["() => ","Observable","<",{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeNavControl","text":"ChromeNavControl"},"[]>"],"description":[],"children":[],"tags":["internal"],"returnComment":[],"source":{"path":"src/core/public/chrome/nav_controls/nav_controls_service.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L48"}}],"source":{"path":"src/core/public/chrome/nav_controls/nav_controls_service.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_controls/nav_controls_service.ts#L36"},"initialIsOpen":false},{"id":"def-public.ChromeNavLink","type":"Interface","label":"ChromeNavLink","description":[],"children":[{"id":"def-public.ChromeNavLink.id","type":"string","label":"id","description":["\nA unique identifier for looking up links."],"source":{"path":"src/core/public/chrome/nav_links/nav_link.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L19"}},{"id":"def-public.ChromeNavLink.title","type":"string","label":"title","description":["\nThe title of the application."],"source":{"path":"src/core/public/chrome/nav_links/nav_link.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L24"}},{"id":"def-public.ChromeNavLink.category","type":"Object","label":"category","description":["\nThe category the app lives in"],"source":{"path":"src/core/public/chrome/nav_links/nav_link.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L29"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.AppCategory","text":"AppCategory"}," | undefined"]},{"id":"def-public.ChromeNavLink.baseUrl","type":"string","label":"baseUrl","description":["\nThe base route used to open the root of an application."],"source":{"path":"src/core/public/chrome/nav_links/nav_link.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L34"}},{"id":"def-public.ChromeNavLink.url","type":"string","label":"url","description":["\nThe route used to open the {@link AppBase.defaultPath | default path } of an application.\nIf unset, `baseUrl` will be used instead."],"source":{"path":"src/core/public/chrome/nav_links/nav_link.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L40"},"signature":["string | undefined"]},{"id":"def-public.ChromeNavLink.order","type":"number","label":"order","description":["\nAn ordinal used to sort nav links relative to one another for display."],"source":{"path":"src/core/public/chrome/nav_links/nav_link.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L45"},"signature":["number | undefined"]},{"id":"def-public.ChromeNavLink.tooltip","type":"string","label":"tooltip","description":["\nA tooltip shown when hovering over an app link."],"source":{"path":"src/core/public/chrome/nav_links/nav_link.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L50"},"signature":["string | undefined"]},{"id":"def-public.ChromeNavLink.euiIconType","type":"string","label":"euiIconType","description":["\nA EUI iconType that will be used for the app's icon. This icon\ntakes precedence over the `icon` property."],"source":{"path":"src/core/public/chrome/nav_links/nav_link.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L56"},"signature":["string | undefined"]},{"id":"def-public.ChromeNavLink.icon","type":"string","label":"icon","description":["\nA URL to an image file used as an icon. Used as a fallback\nif `euiIconType` is not provided."],"source":{"path":"src/core/public/chrome/nav_links/nav_link.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L62"},"signature":["string | undefined"]},{"id":"def-public.ChromeNavLink.href","type":"string","label":"href","description":["\nSettled state between `url`, `baseUrl`, and `active`"],"source":{"path":"src/core/public/chrome/nav_links/nav_link.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L67"}},{"id":"def-public.ChromeNavLink.disabled","type":"CompoundType","label":"disabled","description":["\nDisables a link from being clickable.\n"],"source":{"path":"src/core/public/chrome/nav_links/nav_link.ts","lineNumber":76,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L76"},"signature":["boolean | undefined"]},{"id":"def-public.ChromeNavLink.hidden","type":"CompoundType","label":"hidden","description":["\nHides a link from the navigation."],"source":{"path":"src/core/public/chrome/nav_links/nav_link.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L81"},"signature":["boolean | undefined"]}],"source":{"path":"src/core/public/chrome/nav_links/nav_link.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L15"},"initialIsOpen":false},{"id":"def-public.ChromeNavLinks","type":"Interface","label":"ChromeNavLinks","description":["\n{@link ChromeNavLinks | APIs} for manipulating nav links.\n"],"children":[{"id":"def-public.ChromeNavLinks.getNavLinks$","type":"Function","label":"getNavLinks$","signature":["() => ","Observable","[]>"],"description":["\nGet an observable for a sorted list of navlinks."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/public/chrome/nav_links/nav_links_service.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L32"}},{"id":"def-public.ChromeNavLinks.get","type":"Function","label":"get","signature":["(id: string) => ",{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeNavLink","text":"ChromeNavLink"}," | undefined"],"description":["\nGet the state of a navlink at this point in time."],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/public/chrome/nav_links/nav_links_service.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L38"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/chrome/nav_links/nav_links_service.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L38"}},{"id":"def-public.ChromeNavLinks.getAll","type":"Function","label":"getAll","signature":["() => Readonly<",{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeNavLink","text":"ChromeNavLink"},">[]"],"description":["\nGet the current state of all navlinks."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/public/chrome/nav_links/nav_links_service.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L43"}},{"id":"def-public.ChromeNavLinks.has","type":"Function","label":"has","signature":["(id: string) => boolean"],"description":["\nCheck whether or not a navlink exists."],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/public/chrome/nav_links/nav_links_service.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L49"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/chrome/nav_links/nav_links_service.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L49"}},{"id":"def-public.ChromeNavLinks.showOnly","type":"Function","label":"showOnly","signature":["(id: string) => void"],"description":["\nRemove all navlinks except the one matching the given id.\n"],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/public/chrome/nav_links/nav_links_service.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L59"}}],"tags":["remarks"],"returnComment":[],"source":{"path":"src/core/public/chrome/nav_links/nav_links_service.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L59"}},{"id":"def-public.ChromeNavLinks.update","type":"Function","label":"update","signature":["(id: string, values: Partial>) => ",{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeNavLink","text":"ChromeNavLink"}," | undefined"],"description":["\nUpdate the navlink for the given id with the updated attributes.\nReturns the updated navlink or `undefined` if it does not exist.\n"],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/public/chrome/nav_links/nav_links_service.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L71"}},{"type":"Object","label":"values","isRequired":true,"signature":["Partial>"],"description":[],"source":{"path":"src/core/public/chrome/nav_links/nav_links_service.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L71"}}],"tags":["deprecated"],"returnComment":[],"source":{"path":"src/core/public/chrome/nav_links/nav_links_service.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L71"}},{"id":"def-public.ChromeNavLinks.enableForcedAppSwitcherNavigation","type":"Function","label":"enableForcedAppSwitcherNavigation","signature":["() => void"],"description":["\nEnable forced navigation mode, which will trigger a page refresh\nwhen a nav link is clicked and only the hash is updated.\n"],"children":[],"tags":["remarks"],"returnComment":[],"source":{"path":"src/core/public/chrome/nav_links/nav_links_service.ts","lineNumber":85,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L85"}},{"id":"def-public.ChromeNavLinks.getForceAppSwitcherNavigation$","type":"Function","label":"getForceAppSwitcherNavigation$","signature":["() => ","Observable",""],"description":["\nAn observable of the forced app switcher state."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/public/chrome/nav_links/nav_links_service.ts","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L90"}}],"source":{"path":"src/core/public/chrome/nav_links/nav_links_service.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_links_service.ts#L28"},"initialIsOpen":false},{"id":"def-public.ChromeDocTitle","type":"Interface","label":"ChromeDocTitle","description":["\nAPIs for accessing and updating the document title.\n"],"children":[{"id":"def-public.ChromeDocTitle.change","type":"Function","label":"change","signature":["(newTitle: string | string[]) => void"],"description":["\nChanges the current document title.\n"],"children":[{"type":"CompoundType","label":"newTitle","isRequired":true,"signature":["string | string[]"],"description":["The new title to set, either a string or string array"],"source":{"path":"src/core/public/chrome/doc_title/doc_title_service.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/doc_title/doc_title_service.ts#L45"}}],"tags":["example"],"returnComment":[],"source":{"path":"src/core/public/chrome/doc_title/doc_title_service.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/doc_title/doc_title_service.ts#L45"}},{"id":"def-public.ChromeDocTitle.reset","type":"Function","label":"reset","signature":["() => void"],"description":["\nResets the document title to it's initial value.\n(meaning the one present in the title meta at application load.)"],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/public/chrome/doc_title/doc_title_service.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/doc_title/doc_title_service.ts#L50"}}],"source":{"path":"src/core/public/chrome/doc_title/doc_title_service.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/doc_title/doc_title_service.ts#L32"},"initialIsOpen":false},{"id":"def-public.ChromeRecentlyAccessed","type":"Interface","label":"ChromeRecentlyAccessed","description":["\n{@link ChromeRecentlyAccessed | APIs} for recently accessed history."],"children":[{"id":"def-public.ChromeRecentlyAccessed.add","type":"Function","label":"add","signature":["(link: string, label: string, id: string) => void"],"description":["\nAdds a new item to the recently accessed history.\n"],"children":[{"type":"string","label":"link","isRequired":true,"signature":["string"],"description":["a relative URL to the resource (not including the {@link HttpStart.basePath | `http.basePath`})"],"source":{"path":"src/core/public/chrome/recently_accessed/recently_accessed_service.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L71"}},{"type":"string","label":"label","isRequired":true,"signature":["string"],"description":["the label to display in the UI"],"source":{"path":"src/core/public/chrome/recently_accessed/recently_accessed_service.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L71"}},{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":["a unique string used to de-duplicate the recently accessed list."],"source":{"path":"src/core/public/chrome/recently_accessed/recently_accessed_service.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L71"}}],"tags":["example"],"returnComment":[],"source":{"path":"src/core/public/chrome/recently_accessed/recently_accessed_service.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L71"}},{"id":"def-public.ChromeRecentlyAccessed.get","type":"Function","label":"get","signature":["() => ",{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeRecentlyAccessedHistoryItem","text":"ChromeRecentlyAccessedHistoryItem"},"[]"],"description":["\nGets an Array of the current recently accessed history.\n"],"children":[],"tags":["example"],"returnComment":[],"source":{"path":"src/core/public/chrome/recently_accessed/recently_accessed_service.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L81"}},{"id":"def-public.ChromeRecentlyAccessed.get$","type":"Function","label":"get$","signature":["() => ","Observable","<",{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeRecentlyAccessedHistoryItem","text":"ChromeRecentlyAccessedHistoryItem"},"[]>"],"description":["\nGets an Observable of the array of recently accessed history.\n"],"children":[],"tags":["example"],"returnComment":[],"source":{"path":"src/core/public/chrome/recently_accessed/recently_accessed_service.ts","lineNumber":91,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L91"}}],"source":{"path":"src/core/public/chrome/recently_accessed/recently_accessed_service.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L58"},"initialIsOpen":false},{"id":"def-public.ChromeRecentlyAccessedHistoryItem","type":"Interface","label":"ChromeRecentlyAccessedHistoryItem","description":[],"children":[{"id":"def-public.ChromeRecentlyAccessedHistoryItem.link","type":"string","label":"link","description":[],"source":{"path":"src/core/public/chrome/recently_accessed/recently_accessed_service.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L17"}},{"id":"def-public.ChromeRecentlyAccessedHistoryItem.label","type":"string","label":"label","description":[],"source":{"path":"src/core/public/chrome/recently_accessed/recently_accessed_service.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L18"}},{"id":"def-public.ChromeRecentlyAccessedHistoryItem.id","type":"string","label":"id","description":[],"source":{"path":"src/core/public/chrome/recently_accessed/recently_accessed_service.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L19"}}],"source":{"path":"src/core/public/chrome/recently_accessed/recently_accessed_service.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/recently_accessed/recently_accessed_service.ts#L16"},"initialIsOpen":false},{"id":"def-public.ChromeUserBanner","type":"Interface","label":"ChromeUserBanner","description":[],"children":[{"id":"def-public.ChromeUserBanner.content","type":"Function","label":"content","description":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L41"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.MountPoint","text":"MountPoint"},""]}],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L40"},"initialIsOpen":false},{"id":"def-public.ChromeStart","type":"Interface","label":"ChromeStart","description":["\nChromeStart allows plugins to customize the global chrome header UI and\nenrich the UX with additional information about the current location of the\nbrowser.\n"],"children":[{"id":"def-public.ChromeStart.navLinks","type":"Object","label":"navLinks","description":["{@inheritdoc ChromeNavLinks}"],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L88"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeNavLinks","text":"ChromeNavLinks"}]},{"id":"def-public.ChromeStart.navControls","type":"Object","label":"navControls","description":["{@inheritdoc ChromeNavControls}"],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L90"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeNavControls","text":"ChromeNavControls"}]},{"id":"def-public.ChromeStart.recentlyAccessed","type":"Object","label":"recentlyAccessed","description":["{@inheritdoc ChromeRecentlyAccessed}"],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L92"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeRecentlyAccessed","text":"ChromeRecentlyAccessed"}]},{"id":"def-public.ChromeStart.docTitle","type":"Object","label":"docTitle","description":["{@inheritdoc ChromeDocTitle}"],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L94"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeDocTitle","text":"ChromeDocTitle"}]},{"id":"def-public.ChromeStart.setAppTitle","type":"Function","label":"setAppTitle","signature":["(appTitle: string) => void"],"description":["\nSets the current app's title\n"],"children":[{"type":"string","label":"appTitle","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L103"}}],"tags":["internalRemarks"],"returnComment":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L103"}},{"id":"def-public.ChromeStart.getBrand$","type":"Function","label":"getBrand$","signature":["() => ","Observable","<",{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeBrand","text":"ChromeBrand"},">"],"description":["\nGet an observable of the current brand information."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L108"}},{"id":"def-public.ChromeStart.setBrand","type":"Function","label":"setBrand","signature":["(brand: ",{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeBrand","text":"ChromeBrand"},") => void"],"description":["\nSet the brand configuration.\n"],"children":[{"type":"Object","label":"brand","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeBrand","text":"ChromeBrand"}],"description":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":128,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L128"}}],"tags":["remarks","example"],"returnComment":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":128,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L128"}},{"id":"def-public.ChromeStart.getIsVisible$","type":"Function","label":"getIsVisible$","signature":["() => ","Observable",""],"description":["\nGet an observable of the current visibility state of the chrome."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":133,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L133"}},{"id":"def-public.ChromeStart.setIsVisible","type":"Function","label":"setIsVisible","signature":["(isVisible: boolean) => void"],"description":["\nSet the temporary visibility for the chrome. This does nothing if the chrome is hidden\nby default and should be used to hide the chrome for things like full-screen modes\nwith an exit button."],"children":[{"type":"boolean","label":"isVisible","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":140,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L140"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":140,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L140"}},{"id":"def-public.ChromeStart.getApplicationClasses$","type":"Function","label":"getApplicationClasses$","signature":["() => ","Observable",""],"description":["\nGet the current set of classNames that will be set on the application container."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":145,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L145"}},{"id":"def-public.ChromeStart.addApplicationClass","type":"Function","label":"addApplicationClass","signature":["(className: string) => void"],"description":["\nAdd a className that should be set on the application container."],"children":[{"type":"string","label":"className","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":150,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L150"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":150,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L150"}},{"id":"def-public.ChromeStart.removeApplicationClass","type":"Function","label":"removeApplicationClass","signature":["(className: string) => void"],"description":["\nRemove a className added with `addApplicationClass()`. If className is unknown it is ignored."],"children":[{"type":"string","label":"className","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":155,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L155"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":155,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L155"}},{"id":"def-public.ChromeStart.getBadge$","type":"Function","label":"getBadge$","signature":["() => ","Observable","<",{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeBadge","text":"ChromeBadge"}," | undefined>"],"description":["\nGet an observable of the current badge"],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":160,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L160"}},{"id":"def-public.ChromeStart.setBadge","type":"Function","label":"setBadge","signature":["(badge?: ",{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeBadge","text":"ChromeBadge"}," | undefined) => void"],"description":["\nOverride the current badge"],"children":[{"type":"Object","label":"badge","isRequired":false,"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeBadge","text":"ChromeBadge"}," | undefined"],"description":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":165,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L165"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":165,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L165"}},{"id":"def-public.ChromeStart.getBreadcrumbs$","type":"Function","label":"getBreadcrumbs$","signature":["() => ","Observable","<","EuiBreadcrumb","[]>"],"description":["\nGet an observable of the current list of breadcrumbs"],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":170,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L170"}},{"id":"def-public.ChromeStart.setBreadcrumbs","type":"Function","label":"setBreadcrumbs","signature":["(newBreadcrumbs: ","EuiBreadcrumb","[]) => void"],"description":["\nOverride the current set of breadcrumbs"],"children":[{"type":"Array","label":"newBreadcrumbs","isRequired":true,"signature":["EuiBreadcrumb","[]"],"description":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":175,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L175"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":175,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L175"}},{"id":"def-public.ChromeStart.getBreadcrumbsAppendExtension$","type":"Function","label":"getBreadcrumbsAppendExtension$","signature":["() => ","Observable","<",{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeBreadcrumbsAppendExtension","text":"ChromeBreadcrumbsAppendExtension"}," | undefined>"],"description":["\nGet an observable of the current extension appended to breadcrumbs"],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":180,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L180"}},{"id":"def-public.ChromeStart.setBreadcrumbsAppendExtension","type":"Function","label":"setBreadcrumbsAppendExtension","signature":["(breadcrumbsAppendExtension?: ",{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeBreadcrumbsAppendExtension","text":"ChromeBreadcrumbsAppendExtension"}," | undefined) => void"],"description":["\nMount an element next to the last breadcrumb"],"children":[{"type":"Object","label":"breadcrumbsAppendExtension","isRequired":false,"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeBreadcrumbsAppendExtension","text":"ChromeBreadcrumbsAppendExtension"}," | undefined"],"description":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":186,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L186"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":185,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L185"}},{"id":"def-public.ChromeStart.getCustomNavLink$","type":"Function","label":"getCustomNavLink$","signature":["() => ","Observable"," | undefined>"],"description":["\nGet an observable of the current custom nav link"],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":192,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L192"}},{"id":"def-public.ChromeStart.setCustomNavLink","type":"Function","label":"setCustomNavLink","signature":["(newCustomNavLink?: Partial<",{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeNavLink","text":"ChromeNavLink"},"> | undefined) => void"],"description":["\nOverride the current set of custom nav link"],"children":[{"type":"Object","label":"newCustomNavLink","isRequired":false,"signature":["Partial<",{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeNavLink","text":"ChromeNavLink"},"> | undefined"],"description":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":197,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L197"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":197,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L197"}},{"id":"def-public.ChromeStart.getHelpExtension$","type":"Function","label":"getHelpExtension$","signature":["() => ","Observable","<",{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeHelpExtension","text":"ChromeHelpExtension"}," | undefined>"],"description":["\nGet an observable of the current custom help conttent"],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":202,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L202"}},{"id":"def-public.ChromeStart.setHelpExtension","type":"Function","label":"setHelpExtension","signature":["(helpExtension?: ",{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeHelpExtension","text":"ChromeHelpExtension"}," | undefined) => void"],"description":["\nOverride the current set of custom help content"],"children":[{"type":"Object","label":"helpExtension","isRequired":false,"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeHelpExtension","text":"ChromeHelpExtension"}," | undefined"],"description":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":207,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L207"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":207,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L207"}},{"id":"def-public.ChromeStart.setHelpSupportUrl","type":"Function","label":"setHelpSupportUrl","signature":["(url: string) => void"],"description":["\nOverride the default support URL shown in the help menu"],"children":[{"type":"string","label":"url","isRequired":true,"signature":["string"],"description":["The updated support URL"],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":213,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L213"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":213,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L213"}},{"id":"def-public.ChromeStart.getIsNavDrawerLocked$","type":"Function","label":"getIsNavDrawerLocked$","signature":["() => ","Observable",""],"description":["\nGet an observable of the current locked state of the nav drawer."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":218,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L218"}},{"id":"def-public.ChromeStart.setHeaderBanner","type":"Function","label":"setHeaderBanner","signature":["(headerBanner?: ",{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeUserBanner","text":"ChromeUserBanner"}," | undefined) => void"],"description":["\nSet the banner that will appear on top of the chrome header.\n"],"children":[{"type":"Object","label":"headerBanner","isRequired":false,"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeUserBanner","text":"ChromeUserBanner"}," | undefined"],"description":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":225,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L225"}}],"tags":["remarks"],"returnComment":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":225,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L225"}}],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L86"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-public.ChromeBreadcrumb","type":"Type","label":"ChromeBreadcrumb","description":[],"source":{"path":"src/core/public/chrome/types.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/types.ts#L32"},"signature":["CommonProps"," & { text: ","ReactNode","; href?: string | undefined; onClick?: ((event: ","MouseEvent",") => void) | undefined; truncate?: boolean | undefined; }"],"initialIsOpen":false},{"id":"def-public.ChromeHelpExtensionMenuLink","type":"Type","label":"ChromeHelpExtensionMenuLink","description":[],"source":{"path":"src/core/public/chrome/ui/header/header_help_menu.tsx","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L98"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeHelpExtensionMenuGitHubLink","text":"ChromeHelpExtensionMenuGitHubLink"}," | ",{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeHelpExtensionMenuDiscussLink","text":"ChromeHelpExtensionMenuDiscussLink"}," | ",{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeHelpExtensionMenuDocumentationLink","text":"ChromeHelpExtensionMenuDocumentationLink"}," | ",{"pluginId":"core","scope":"public","docId":"kibCoreChromePluginApi","section":"def-public.ChromeHelpExtensionMenuCustomLink","text":"ChromeHelpExtensionMenuCustomLink"}],"initialIsOpen":false},{"id":"def-public.ChromeHelpExtensionLinkBase","type":"Type","label":"ChromeHelpExtensionLinkBase","description":[],"source":{"path":"src/core/public/chrome/ui/header/header_help_menu.tsx","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/header_help_menu.tsx#L34"},"signature":["{ iconType?: string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined; 'data-test-subj'?: string | undefined; target?: string | undefined; rel?: string | undefined; }"],"initialIsOpen":false},{"id":"def-public.ChromeNavLinkUpdateableFields","type":"Type","label":"ChromeNavLinkUpdateableFields","description":[],"source":{"path":"src/core/public/chrome/nav_links/nav_link.ts","lineNumber":85,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/nav_links/nav_link.ts#L85"},"signature":["{ readonly hidden?: boolean | undefined; readonly disabled?: boolean | undefined; readonly href?: string | undefined; readonly url?: string | undefined; }"],"initialIsOpen":false},{"id":"def-public.NavType","type":"Type","label":"NavType","description":[],"source":{"path":"src/core/public/chrome/ui/header/types.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/chrome/ui/header/types.ts#L10"},"signature":["\"legacy\" | \"modern\""],"initialIsOpen":false}],"objects":[]},"server":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]}} \ No newline at end of file diff --git a/api_docs/core_chrome.mdx b/api_docs/core_chrome.mdx new file mode 100644 index 0000000000000..30bbf4c7171b8 --- /dev/null +++ b/api_docs/core_chrome.mdx @@ -0,0 +1,18 @@ +--- +id: kibCoreChromePluginApi +slug: /kibana-dev-docs/core.chromePluginApi +title: core.chrome +image: https://source.unsplash.com/400x175/?github +summary: API docs for the core.chrome plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.chrome'] +--- + +import coreChromeObj from './core_chrome.json'; + +## Client + +### Interfaces + +### Consts, variables and types + diff --git a/api_docs/core_http.json b/api_docs/core_http.json new file mode 100644 index 0000000000000..bc545ecff98ae --- /dev/null +++ b/api_docs/core_http.json @@ -0,0 +1 @@ +{"id":"core.http","client":{"classes":[{"id":"def-public.HttpFetchError","type":"Class","label":"HttpFetchError","description":[],"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpFetchError","text":"HttpFetchError"}," extends Error implements ",{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.IHttpFetchError","text":"IHttpFetchError"}],"children":[{"id":"def-public.HttpFetchError.name","type":"string","label":"name","description":[],"source":{"path":"src/core/public/http/http_fetch_error.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/http_fetch_error.ts#L13"}},{"id":"def-public.HttpFetchError.req","type":"Object","label":"req","description":[],"source":{"path":"src/core/public/http/http_fetch_error.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/http_fetch_error.ts#L14"},"signature":["Request"]},{"id":"def-public.HttpFetchError.res","type":"Object","label":"res","description":[],"source":{"path":"src/core/public/http/http_fetch_error.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/http_fetch_error.ts#L15"},"signature":["Response | undefined"]},{"id":"def-public.HttpFetchError.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"string","label":"message","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/public/http/http_fetch_error.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/http_fetch_error.ts#L18"}},{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/public/http/http_fetch_error.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/http_fetch_error.ts#L19"}},{"type":"Object","label":"request","isRequired":true,"signature":["Request"],"description":[],"source":{"path":"src/core/public/http/http_fetch_error.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/http_fetch_error.ts#L20"}},{"type":"Object","label":"response","isRequired":false,"signature":["Response | undefined"],"description":[],"source":{"path":"src/core/public/http/http_fetch_error.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/http_fetch_error.ts#L21"}},{"type":"Any","label":"body","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/core/public/http/http_fetch_error.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/http_fetch_error.ts#L22"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/http/http_fetch_error.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/http_fetch_error.ts#L17"}}],"source":{"path":"src/core/public/http/http_fetch_error.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/http_fetch_error.ts#L12"},"initialIsOpen":false}],"functions":[],"interfaces":[{"id":"def-public.HttpHeadersInit","type":"Interface","label":"HttpHeadersInit","description":["\nHeaders to append to the request. Any headers that begin with `kbn-` are considered private to Core and will cause\n{@link HttpHandler} to throw an error."],"children":[{"id":"def-public.HttpHeadersInit.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":145,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L145"},"signature":["any"]}],"source":{"path":"src/core/public/http/types.ts","lineNumber":144,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L144"},"initialIsOpen":false},{"id":"def-public.HttpRequestInit","type":"Interface","label":"HttpRequestInit","description":["\nFetch API options available to {@link HttpHandler}s.\n"],"children":[{"id":"def-public.HttpRequestInit.body","type":"CompoundType","label":"body","description":["\nA BodyInit object or null to set request's body."],"source":{"path":"src/core/public/http/types.ts","lineNumber":158,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L158"},"signature":["string | ArrayBuffer | Blob | URLSearchParams | ArrayBufferView | FormData | ReadableStream | null | undefined"]},{"id":"def-public.HttpRequestInit.cache","type":"CompoundType","label":"cache","description":["\nThe cache mode associated with request, which is a string indicating how the request will interact with the\nbrowser's cache when fetching."],"source":{"path":"src/core/public/http/types.ts","lineNumber":164,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L164"},"signature":["\"default\" | \"reload\" | \"force-cache\" | \"no-cache\" | \"no-store\" | \"only-if-cached\" | undefined"]},{"id":"def-public.HttpRequestInit.credentials","type":"CompoundType","label":"credentials","description":["\nThe credentials mode associated with request, which is a string indicating whether credentials will be sent with\nthe request always, never, or only when sent to a same-origin URL."],"source":{"path":"src/core/public/http/types.ts","lineNumber":170,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L170"},"signature":["\"include\" | \"omit\" | \"same-origin\" | undefined"]},{"id":"def-public.HttpRequestInit.headers","type":"Object","label":"headers","description":["{@link HttpHeadersInit}"],"source":{"path":"src/core/public/http/types.ts","lineNumber":173,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L173"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpHeadersInit","text":"HttpHeadersInit"}," | undefined"]},{"id":"def-public.HttpRequestInit.integrity","type":"string","label":"integrity","description":["\nSubresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of\nmultiple hashes separated by whitespace."],"source":{"path":"src/core/public/http/types.ts","lineNumber":179,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L179"},"signature":["string | undefined"]},{"id":"def-public.HttpRequestInit.keepalive","type":"CompoundType","label":"keepalive","description":["Whether or not request can outlive the global in which it was created."],"source":{"path":"src/core/public/http/types.ts","lineNumber":182,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L182"},"signature":["boolean | undefined"]},{"id":"def-public.HttpRequestInit.method","type":"string","label":"method","description":["HTTP method, which is \"GET\" by default."],"source":{"path":"src/core/public/http/types.ts","lineNumber":185,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L185"},"signature":["string | undefined"]},{"id":"def-public.HttpRequestInit.mode","type":"CompoundType","label":"mode","description":["\nThe mode associated with request, which is a string indicating whether the request will use CORS, or will be\nrestricted to same-origin URLs."],"source":{"path":"src/core/public/http/types.ts","lineNumber":191,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L191"},"signature":["\"same-origin\" | \"cors\" | \"navigate\" | \"no-cors\" | undefined"]},{"id":"def-public.HttpRequestInit.redirect","type":"CompoundType","label":"redirect","description":["\nThe redirect mode associated with request, which is a string indicating how redirects for the request will be\nhandled during fetching. A request will follow redirects by default."],"source":{"path":"src/core/public/http/types.ts","lineNumber":197,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L197"},"signature":["\"error\" | \"manual\" | \"follow\" | undefined"]},{"id":"def-public.HttpRequestInit.referrer","type":"string","label":"referrer","description":["\nThe referrer of request. Its value can be a same-origin URL if explicitly set in init, the empty string to\nindicate no referrer, and \"about:client\" when defaulting to the global's default. This is used during fetching to\ndetermine the value of the `Referer` header of the request being made."],"source":{"path":"src/core/public/http/types.ts","lineNumber":204,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L204"},"signature":["string | undefined"]},{"id":"def-public.HttpRequestInit.referrerPolicy","type":"CompoundType","label":"referrerPolicy","description":["\nThe referrer policy associated with request. This is used during fetching to compute the value of the request's\nreferrer."],"source":{"path":"src/core/public/http/types.ts","lineNumber":210,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L210"},"signature":["\"\" | \"origin\" | \"no-referrer\" | \"unsafe-url\" | \"same-origin\" | \"no-referrer-when-downgrade\" | \"origin-when-cross-origin\" | \"strict-origin\" | \"strict-origin-when-cross-origin\" | undefined"]},{"id":"def-public.HttpRequestInit.signal","type":"CompoundType","label":"signal","description":["\nReturns the signal associated with request, which is an AbortSignal object indicating whether or not request has\nbeen aborted, and its abort event handler."],"source":{"path":"src/core/public/http/types.ts","lineNumber":216,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L216"},"signature":["AbortSignal | null | undefined"]},{"id":"def-public.HttpRequestInit.window","type":"Uncategorized","label":"window","description":["\nCan only be null. Used to disassociate request from any Window."],"source":{"path":"src/core/public/http/types.ts","lineNumber":221,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L221"},"signature":["null | undefined"]}],"source":{"path":"src/core/public/http/types.ts","lineNumber":154,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L154"},"initialIsOpen":false},{"id":"def-public.HttpFetchOptions","type":"Interface","label":"HttpFetchOptions","signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpFetchOptions","text":"HttpFetchOptions"}," extends ",{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpRequestInit","text":"HttpRequestInit"}],"description":["\nAll options that may be used with a {@link HttpHandler}."],"children":[{"id":"def-public.HttpFetchOptions.query","type":"Object","label":"query","description":["\nThe query string for an HTTP request. See {@link HttpFetchQuery}."],"source":{"path":"src/core/public/http/types.ts","lineNumber":249,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L249"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpFetchQuery","text":"HttpFetchQuery"}," | undefined"]},{"id":"def-public.HttpFetchOptions.prependBasePath","type":"CompoundType","label":"prependBasePath","description":["\nWhether or not the request should automatically prepend the basePath. Defaults to `true`."],"source":{"path":"src/core/public/http/types.ts","lineNumber":254,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L254"},"signature":["boolean | undefined"]},{"id":"def-public.HttpFetchOptions.headers","type":"Object","label":"headers","description":["\nHeaders to send with the request. See {@link HttpHeadersInit}."],"source":{"path":"src/core/public/http/types.ts","lineNumber":259,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L259"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpHeadersInit","text":"HttpHeadersInit"}," | undefined"]},{"id":"def-public.HttpFetchOptions.asSystemRequest","type":"CompoundType","label":"asSystemRequest","description":["\nWhether or not the request should include the \"system request\" header to differentiate an end user request from\nKibana internal request.\nCan be read on the server-side using KibanaRequest#isSystemRequest. Defaults to `false`."],"source":{"path":"src/core/public/http/types.ts","lineNumber":266,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L266"},"signature":["boolean | undefined"]},{"id":"def-public.HttpFetchOptions.asResponse","type":"CompoundType","label":"asResponse","description":["\nWhen `true` the return type of {@link HttpHandler} will be an {@link HttpResponse} with detailed request and\nresponse information. When `false`, the return type will just be the parsed response body. Defaults to `false`."],"source":{"path":"src/core/public/http/types.ts","lineNumber":272,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L272"},"signature":["boolean | undefined"]}],"source":{"path":"src/core/public/http/types.ts","lineNumber":245,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L245"},"initialIsOpen":false},{"id":"def-public.HttpFetchOptionsWithPath","type":"Interface","label":"HttpFetchOptionsWithPath","signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpFetchOptionsWithPath","text":"HttpFetchOptionsWithPath"}," extends ",{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpFetchOptions","text":"HttpFetchOptions"}],"description":["\nSimilar to {@link HttpFetchOptions} but with the URL path included."],"children":[{"id":"def-public.HttpFetchOptionsWithPath.path","type":"string","label":"path","description":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":283,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L283"}}],"source":{"path":"src/core/public/http/types.ts","lineNumber":279,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L279"},"initialIsOpen":false},{"id":"def-public.HttpFetchQuery","type":"Interface","label":"HttpFetchQuery","description":[],"children":[{"id":"def-public.HttpFetchQuery.Unnamed","type":"Any","label":"Unnamed","description":["\nTypeScript note: Technically we should use this interface instead, but @types/node uses the below stricter\ndefinition, so to avoid TypeScript errors, we'll restrict our version.\n\n[key: string]:\n | string\n | number\n | boolean\n | Array\n | undefined\n | null;"],"source":{"path":"src/core/public/http/types.ts","lineNumber":238,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L238"},"signature":["any"]}],"source":{"path":"src/core/public/http/types.ts","lineNumber":225,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L225"},"initialIsOpen":false},{"id":"def-public.HttpInterceptorResponseError","type":"Interface","label":"HttpInterceptorResponseError","signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpInterceptorResponseError","text":"HttpInterceptorResponseError"}," extends ",{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpResponse","text":"HttpResponse"},""],"description":[],"children":[{"id":"def-public.HttpInterceptorResponseError.request","type":"Object","label":"request","description":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":347,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L347"},"signature":["Readonly"]},{"id":"def-public.HttpInterceptorResponseError.error","type":"CompoundType","label":"error","description":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":348,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L348"},"signature":["Error | ",{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.IHttpFetchError","text":"IHttpFetchError"}]}],"source":{"path":"src/core/public/http/types.ts","lineNumber":346,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L346"},"initialIsOpen":false},{"id":"def-public.HttpInterceptorRequestError","type":"Interface","label":"HttpInterceptorRequestError","description":[],"children":[{"id":"def-public.HttpInterceptorRequestError.fetchOptions","type":"Object","label":"fetchOptions","description":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":352,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L352"},"signature":["Readonly<",{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpFetchOptionsWithPath","text":"HttpFetchOptionsWithPath"},">"]},{"id":"def-public.HttpInterceptorRequestError.error","type":"Object","label":"error","description":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":353,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L353"},"signature":["Error"]}],"source":{"path":"src/core/public/http/types.ts","lineNumber":351,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L351"},"initialIsOpen":false},{"id":"def-public.HttpInterceptor","type":"Interface","label":"HttpInterceptor","description":["\nAn object that may define global interceptor functions for different parts of the request and response lifecycle.\nSee {@link IHttpInterceptController}.\n"],"children":[{"id":"def-public.HttpInterceptor.request","type":"Function","label":"request","signature":["((fetchOptions: Readonly<",{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpFetchOptionsWithPath","text":"HttpFetchOptionsWithPath"},">, controller: ",{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.IHttpInterceptController","text":"IHttpInterceptController"},") => void | Partial<",{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpFetchOptionsWithPath","text":"HttpFetchOptionsWithPath"},"> | Promise>) | undefined"],"description":["\nDefine an interceptor to be executed before a request is sent."],"children":[{"type":"Object","label":"fetchOptions","isRequired":true,"signature":["Readonly<",{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpFetchOptionsWithPath","text":"HttpFetchOptionsWithPath"},">"],"description":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":369,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L369"}},{"type":"Object","label":"controller","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.IHttpInterceptController","text":"IHttpInterceptController"}],"description":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":370,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L370"}}],"tags":["link"],"returnComment":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":368,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L368"}},{"id":"def-public.HttpInterceptor.requestError","type":"Function","label":"requestError","signature":["((httpErrorRequest: ",{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpInterceptorRequestError","text":"HttpInterceptorRequestError"},", controller: ",{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.IHttpInterceptController","text":"IHttpInterceptController"},") => void | Partial<",{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpFetchOptionsWithPath","text":"HttpFetchOptionsWithPath"},"> | Promise>) | undefined"],"description":["\nDefine an interceptor to be executed if a request interceptor throws an error or returns a rejected Promise."],"children":[{"type":"Object","label":"httpErrorRequest","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpInterceptorRequestError","text":"HttpInterceptorRequestError"}],"description":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":379,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L379"}},{"type":"Object","label":"controller","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.IHttpInterceptController","text":"IHttpInterceptController"}],"description":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":380,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L380"}}],"tags":["link","link"],"returnComment":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":378,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L378"}},{"id":"def-public.HttpInterceptor.response","type":"Function","label":"response","signature":["((httpResponse: ",{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpResponse","text":"HttpResponse"},", controller: ",{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.IHttpInterceptController","text":"IHttpInterceptController"},") => void | ",{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.IHttpResponseInterceptorOverrides","text":"IHttpResponseInterceptorOverrides"}," | Promise<",{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.IHttpResponseInterceptorOverrides","text":"IHttpResponseInterceptorOverrides"},">) | undefined"],"description":["\nDefine an interceptor to be executed after a response is received."],"children":[{"type":"Object","label":"httpResponse","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpResponse","text":"HttpResponse"},""],"description":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":389,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L389"}},{"type":"Object","label":"controller","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.IHttpInterceptController","text":"IHttpInterceptController"}],"description":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":390,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L390"}}],"tags":["link","link"],"returnComment":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":388,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L388"}},{"id":"def-public.HttpInterceptor.responseError","type":"Function","label":"responseError","signature":["((httpErrorResponse: ",{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpInterceptorResponseError","text":"HttpInterceptorResponseError"},", controller: ",{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.IHttpInterceptController","text":"IHttpInterceptController"},") => void | ",{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.IHttpResponseInterceptorOverrides","text":"IHttpResponseInterceptorOverrides"}," | Promise<",{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.IHttpResponseInterceptorOverrides","text":"IHttpResponseInterceptorOverrides"},">) | undefined"],"description":["\nDefine an interceptor to be executed if a response interceptor throws an error or returns a rejected Promise."],"children":[{"type":"Object","label":"httpErrorResponse","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpInterceptorResponseError","text":"HttpInterceptorResponseError"}],"description":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":399,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L399"}},{"type":"Object","label":"controller","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.IHttpInterceptController","text":"IHttpInterceptController"}],"description":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":400,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L400"}}],"tags":["link","link"],"returnComment":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":398,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L398"}}],"source":{"path":"src/core/public/http/types.ts","lineNumber":362,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L362"},"initialIsOpen":false},{"id":"def-public.HttpResponse","type":"Interface","label":"HttpResponse","signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpResponse","text":"HttpResponse"},""],"description":[],"children":[{"id":"def-public.HttpResponse.fetchOptions","type":"Object","label":"fetchOptions","description":["The original {@link HttpFetchOptionsWithPath} used to send this request."],"source":{"path":"src/core/public/http/types.ts","lineNumber":309,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L309"},"signature":["Readonly<",{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpFetchOptionsWithPath","text":"HttpFetchOptionsWithPath"},">"]},{"id":"def-public.HttpResponse.request","type":"Object","label":"request","description":["Raw request sent to Kibana server."],"source":{"path":"src/core/public/http/types.ts","lineNumber":311,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L311"},"signature":["Readonly"]},{"id":"def-public.HttpResponse.response","type":"Object","label":"response","description":["Raw response received, may be undefined if there was an error."],"source":{"path":"src/core/public/http/types.ts","lineNumber":313,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L313"},"signature":["Readonly | undefined"]},{"id":"def-public.HttpResponse.body","type":"Uncategorized","label":"body","description":["Parsed body received, may be undefined if there was an error."],"source":{"path":"src/core/public/http/types.ts","lineNumber":315,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L315"},"signature":["TResponseBody | undefined"]}],"source":{"path":"src/core/public/http/types.ts","lineNumber":307,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L307"},"initialIsOpen":false},{"id":"def-public.HttpHandler","type":"Interface","label":"HttpHandler","description":["\nA function for making an HTTP requests to Kibana's backend. See {@link HttpFetchOptions} for options and\n{@link HttpResponse} for the response.\n"],"children":[{"id":"def-public.HttpHandler.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":296,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L296"},"signature":["any"]},{"id":"def-public.HttpHandler.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":299,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L299"},"signature":["any"]},{"id":"def-public.HttpHandler.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":302,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L302"},"signature":["any"]},{"id":"def-public.HttpHandler.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":303,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L303"},"signature":["any"]}],"source":{"path":"src/core/public/http/types.ts","lineNumber":295,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L295"},"initialIsOpen":false},{"id":"def-public.IBasePath","type":"Interface","label":"IBasePath","description":["\nAPIs for manipulating the basePath on URL segments."],"children":[{"id":"def-public.IBasePath.get","type":"Function","label":"get","description":["\nGets the `basePath` string."],"source":{"path":"src/core/public/http/types.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L78"},"signature":["() => string"]},{"id":"def-public.IBasePath.prepend","type":"Function","label":"prepend","description":["\nPrepends `path` with the basePath."],"source":{"path":"src/core/public/http/types.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L83"},"signature":["(url: string) => string"]},{"id":"def-public.IBasePath.remove","type":"Function","label":"remove","description":["\nRemoves the prepended basePath from the `path`."],"source":{"path":"src/core/public/http/types.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L88"},"signature":["(url: string) => string"]},{"id":"def-public.IBasePath.serverBasePath","type":"string","label":"serverBasePath","description":["\nReturns the server's root basePath as configured, without any namespace prefix.\n\nSee {@link BasePath.get} for getting the basePath value for a specific request"],"source":{"path":"src/core/public/http/types.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L95"}},{"id":"def-public.IBasePath.publicBaseUrl","type":"string","label":"publicBaseUrl","description":["\nThe server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the\n{@link IBasePath.serverBasePath}.\n"],"source":{"path":"src/core/public/http/types.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L104"},"signature":["string | undefined"]}],"source":{"path":"src/core/public/http/types.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L74"},"initialIsOpen":false},{"id":"def-public.IAnonymousPaths","type":"Interface","label":"IAnonymousPaths","description":["\nAPIs for denoting paths as not requiring authentication"],"children":[{"id":"def-public.IAnonymousPaths.isAnonymous","type":"Function","label":"isAnonymous","signature":["(path: string) => boolean"],"description":["\nDetermines whether the provided path doesn't require authentication. `path` should include the current basePath."],"children":[{"type":"string","label":"path","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L131"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L131"}},{"id":"def-public.IAnonymousPaths.register","type":"Function","label":"register","signature":["(path: string) => void"],"description":["\nRegister `path` as not requiring authentication. `path` should not include the current basePath."],"children":[{"type":"string","label":"path","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":136,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L136"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":136,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L136"}}],"source":{"path":"src/core/public/http/types.ts","lineNumber":127,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L127"},"initialIsOpen":false},{"id":"def-public.IExternalUrl","type":"Interface","label":"IExternalUrl","description":["\nAPIs for working with external URLs.\n"],"children":[{"id":"def-public.IExternalUrl.validateUrl","type":"Function","label":"validateUrl","signature":["(relativeOrAbsoluteUrl: string) => URL | null"],"description":["\nDetermines if the provided URL is a valid location to send users.\nValidation is based on the configured allow list in kibana.yml.\n\nIf the URL is valid, then a URL will be returned.\nOtherwise, this will return null.\n"],"children":[{"type":"string","label":"relativeOrAbsoluteUrl","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":121,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L121"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":121,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L121"}}],"source":{"path":"src/core/public/http/types.ts","lineNumber":111,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L111"},"initialIsOpen":false},{"id":"def-public.IHttpInterceptController","type":"Interface","label":"IHttpInterceptController","description":["\nUsed to halt a request Promise chain in a {@link HttpInterceptor}."],"children":[{"id":"def-public.IHttpInterceptController.halted","type":"boolean","label":"halted","description":["Whether or not this chain has been halted."],"source":{"path":"src/core/public/http/types.ts","lineNumber":410,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L410"}},{"id":"def-public.IHttpInterceptController.halt","type":"Function","label":"halt","signature":["() => void"],"description":["Halt the request Promise chain and do not process further interceptors or response handlers."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":412,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L412"}}],"source":{"path":"src/core/public/http/types.ts","lineNumber":408,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L408"},"initialIsOpen":false},{"id":"def-public.IHttpFetchError","type":"Interface","label":"IHttpFetchError","signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.IHttpFetchError","text":"IHttpFetchError"}," extends Error"],"description":[],"children":[{"id":"def-public.IHttpFetchError.name","type":"string","label":"name","description":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":331,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L331"}},{"id":"def-public.IHttpFetchError.request","type":"Object","label":"request","description":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":332,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L332"},"signature":["Request"]},{"id":"def-public.IHttpFetchError.response","type":"Object","label":"response","description":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":333,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L333"},"signature":["Response | undefined"]},{"id":"def-public.IHttpFetchError.req","type":"Object","label":"req","description":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":337,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L337"},"signature":["Request"]},{"id":"def-public.IHttpFetchError.res","type":"Object","label":"res","description":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":341,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L341"},"signature":["Response | undefined"]},{"id":"def-public.IHttpFetchError.body","type":"Any","label":"body","description":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":342,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L342"},"signature":["any"]}],"source":{"path":"src/core/public/http/types.ts","lineNumber":330,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L330"},"initialIsOpen":false},{"id":"def-public.IHttpResponseInterceptorOverrides","type":"Interface","label":"IHttpResponseInterceptorOverrides","signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.IHttpResponseInterceptorOverrides","text":"IHttpResponseInterceptorOverrides"},""],"description":["\nProperties that can be returned by HttpInterceptor.request to override the response."],"children":[{"id":"def-public.IHttpResponseInterceptorOverrides.response","type":"Object","label":"response","description":["Raw response received, may be undefined if there was an error."],"source":{"path":"src/core/public/http/types.ts","lineNumber":324,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L324"},"signature":["Readonly | undefined"]},{"id":"def-public.IHttpResponseInterceptorOverrides.body","type":"Uncategorized","label":"body","description":["Parsed body received, may be undefined if there was an error."],"source":{"path":"src/core/public/http/types.ts","lineNumber":326,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L326"},"signature":["TResponseBody | undefined"]}],"source":{"path":"src/core/public/http/types.ts","lineNumber":322,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L322"},"initialIsOpen":false},{"id":"def-public.HttpSetup","type":"Interface","label":"HttpSetup","description":[],"children":[{"id":"def-public.HttpSetup.basePath","type":"Object","label":"basePath","description":["\nAPIs for manipulating the basePath on URL segments.\nSee {@link IBasePath}"],"source":{"path":"src/core/public/http/types.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L18"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.IBasePath","text":"IBasePath"}]},{"id":"def-public.HttpSetup.anonymousPaths","type":"Object","label":"anonymousPaths","description":["\nAPIs for denoting certain paths for not requiring authentication"],"source":{"path":"src/core/public/http/types.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L23"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.IAnonymousPaths","text":"IAnonymousPaths"}]},{"id":"def-public.HttpSetup.externalUrl","type":"Object","label":"externalUrl","description":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L25"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.IExternalUrl","text":"IExternalUrl"}]},{"id":"def-public.HttpSetup.intercept","type":"Function","label":"intercept","signature":["(interceptor: ",{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpInterceptor","text":"HttpInterceptor"},") => () => void"],"description":["\nAdds a new {@link HttpInterceptor} to the global HTTP client."],"children":[{"type":"Object","label":"interceptor","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpInterceptor","text":"HttpInterceptor"}],"description":["a {@link HttpInterceptor}"],"source":{"path":"src/core/public/http/types.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L32"}}],"tags":[],"returnComment":["a function for removing the attached interceptor."],"source":{"path":"src/core/public/http/types.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L32"}},{"id":"def-public.HttpSetup.fetch","type":"Function","label":"fetch","description":["Makes an HTTP request. Defaults to a GET request unless overriden. See {@link HttpHandler} for options."],"source":{"path":"src/core/public/http/types.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L35"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpHandler","text":"HttpHandler"}]},{"id":"def-public.HttpSetup.delete","type":"Function","label":"delete","description":["Makes an HTTP request with the DELETE method. See {@link HttpHandler} for options."],"source":{"path":"src/core/public/http/types.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L37"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpHandler","text":"HttpHandler"}]},{"id":"def-public.HttpSetup.get","type":"Function","label":"get","description":["Makes an HTTP request with the GET method. See {@link HttpHandler} for options."],"source":{"path":"src/core/public/http/types.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L39"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpHandler","text":"HttpHandler"}]},{"id":"def-public.HttpSetup.head","type":"Function","label":"head","description":["Makes an HTTP request with the HEAD method. See {@link HttpHandler} for options."],"source":{"path":"src/core/public/http/types.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L41"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpHandler","text":"HttpHandler"}]},{"id":"def-public.HttpSetup.options","type":"Function","label":"options","description":["Makes an HTTP request with the OPTIONS method. See {@link HttpHandler} for options."],"source":{"path":"src/core/public/http/types.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L43"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpHandler","text":"HttpHandler"}]},{"id":"def-public.HttpSetup.patch","type":"Function","label":"patch","description":["Makes an HTTP request with the PATCH method. See {@link HttpHandler} for options."],"source":{"path":"src/core/public/http/types.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L45"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpHandler","text":"HttpHandler"}]},{"id":"def-public.HttpSetup.post","type":"Function","label":"post","description":["Makes an HTTP request with the POST method. See {@link HttpHandler} for options."],"source":{"path":"src/core/public/http/types.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L47"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpHandler","text":"HttpHandler"}]},{"id":"def-public.HttpSetup.put","type":"Function","label":"put","description":["Makes an HTTP request with the PUT method. See {@link HttpHandler} for options."],"source":{"path":"src/core/public/http/types.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L49"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpHandler","text":"HttpHandler"}]},{"id":"def-public.HttpSetup.addLoadingCountSource","type":"Function","label":"addLoadingCountSource","signature":["(countSource$: ","Observable",") => void"],"description":["\nAdds a new source of loading counts. Used to show the global loading indicator when sum of all observed counts are\nmore than 0."],"children":[{"type":"Object","label":"countSource$","isRequired":true,"signature":["Observable",""],"description":["an Observable to subscribe to for loading count updates."],"source":{"path":"src/core/public/http/types.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L56"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L56"}},{"id":"def-public.HttpSetup.getLoadingCount$","type":"Function","label":"getLoadingCount$","signature":["() => ","Observable",""],"description":["\nGet the sum of all loading count sources as a single Observable."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/public/http/types.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L61"}}],"source":{"path":"src/core/public/http/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L13"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-public.HttpStart","type":"Type","label":"HttpStart","description":["\nSee {@link HttpSetup}"],"source":{"path":"src/core/public/http/types.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/http/types.ts#L68"},"signature":["HttpSetup"],"initialIsOpen":false}],"objects":[]},"server":{"classes":[{"id":"def-server.BasePath","type":"Class","label":"BasePath","description":["\nAccess or manipulate the Kibana base path\n"],"children":[{"id":"def-server.BasePath.serverBasePath","type":"string","label":"serverBasePath","description":["\nreturns the server's basePath\n\nSee {@link BasePath.get} for getting the basePath value for a specific request"],"source":{"path":"src/core/server/http/base_path_service.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/base_path_service.ts#L26"}},{"id":"def-server.BasePath.publicBaseUrl","type":"string","label":"publicBaseUrl","description":["\nThe server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the\n{@link BasePath.serverBasePath}.\n"],"source":{"path":"src/core/server/http/base_path_service.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/base_path_service.ts#L34"},"signature":["string | undefined"]},{"id":"def-server.BasePath.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"string","label":"serverBasePath","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/http/base_path_service.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/base_path_service.ts#L37"}},{"type":"string","label":"publicBaseUrl","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"src/core/server/http/base_path_service.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/base_path_service.ts#L37"}}],"tags":["internal"],"returnComment":[],"source":{"path":"src/core/server/http/base_path_service.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/base_path_service.ts#L37"}},{"id":"def-server.BasePath.get","type":"Function","children":[{"type":"CompoundType","label":"request","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.LegacyRequest","text":"LegacyRequest"}],"description":[],"source":{"path":"src/core/server/http/base_path_service.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/base_path_service.ts#L45"}}],"signature":["(request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.LegacyRequest","text":"LegacyRequest"},") => string"],"description":["\nreturns `basePath` value, specific for an incoming request."],"label":"get","source":{"path":"src/core/server/http/base_path_service.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/base_path_service.ts#L45"},"returnComment":[]},{"id":"def-server.BasePath.set","type":"Function","children":[{"type":"CompoundType","label":"request","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.LegacyRequest","text":"LegacyRequest"}],"description":[],"source":{"path":"src/core/server/http/base_path_service.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/base_path_service.ts#L55"}},{"type":"string","label":"requestSpecificBasePath","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/http/base_path_service.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/base_path_service.ts#L55"}}],"signature":["(request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.LegacyRequest","text":"LegacyRequest"},", requestSpecificBasePath: string) => void"],"description":["\nsets `basePath` value, specific for an incoming request.\n"],"label":"set","source":{"path":"src/core/server/http/base_path_service.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/base_path_service.ts#L55"},"returnComment":[]},{"id":"def-server.BasePath.prepend","type":"Function","children":[{"type":"string","label":"path","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/http/base_path_service.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/base_path_service.ts#L69"}}],"signature":["(path: string) => string"],"description":["\nPrepends `path` with the basePath."],"label":"prepend","source":{"path":"src/core/server/http/base_path_service.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/base_path_service.ts#L69"},"returnComment":[]},{"id":"def-server.BasePath.remove","type":"Function","children":[{"type":"string","label":"path","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/http/base_path_service.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/base_path_service.ts#L81"}}],"signature":["(path: string) => string"],"description":["\nRemoves the prepended basePath from the `path`."],"label":"remove","source":{"path":"src/core/server/http/base_path_service.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/base_path_service.ts#L81"},"returnComment":[]}],"source":{"path":"src/core/server/http/base_path_service.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/base_path_service.ts#L18"},"initialIsOpen":false},{"id":"def-server.KibanaRequest","type":"Class","label":"KibanaRequest","description":["\nKibana specific abstraction for an incoming request."],"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},""],"children":[{"id":"def-server.KibanaRequest.from","type":"Function","label":"from","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},".from"],"description":["\nFactory for creating requests. Validates the request before creating an\ninstance of a KibanaRequest."],"children":[{"type":"Object","label":"req","isRequired":true,"signature":["Request"],"description":[],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L102"}},{"type":"CompoundType","label":"routeSchemas","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RouteValidator","text":"RouteValidator"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RouteValidatorFullConfig","text":"RouteValidatorFullConfig"},""],"description":[],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L103"}},{"type":"boolean","label":"withoutSecretHeaders","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L104"}}],"tags":["internal"],"returnComment":[],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L101"}},{"id":"def-server.KibanaRequest.id","type":"string","label":"id","description":["\nA identifier to identify this request.\n"],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":145,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L145"}},{"id":"def-server.KibanaRequest.uuid","type":"string","label":"uuid","description":["\nA UUID to identify this request.\n"],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":153,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L153"}},{"id":"def-server.KibanaRequest.url","type":"Object","label":"url","description":["a WHATWG URL standard object."],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":155,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L155"},"signature":["URL"]},{"id":"def-server.KibanaRequest.route","type":"Object","label":"route","description":["matched route details"],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":157,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L157"},"signature":["Readonly<{ path: string; method: ","RecursiveReadonly","; options: ","RecursiveReadonly","<",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequestRouteOptions","text":"KibanaRequestRouteOptions"},">; }>"]},{"id":"def-server.KibanaRequest.headers","type":"CompoundType","label":"headers","description":["\nReadonly copy of incoming request headers."],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":163,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L163"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.Headers","text":"Headers"}]},{"id":"def-server.KibanaRequest.isSystemRequest","type":"boolean","label":"isSystemRequest","description":["\nWhether or not the request is a \"system request\" rather than an application-level request.\nCan be set on the client using the `HttpFetchOptions#asSystemRequest` option."],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":168,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L168"}},{"id":"def-server.KibanaRequest.socket","type":"Object","label":"socket","description":["{@link IKibanaSocket}"],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":171,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L171"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.IKibanaSocket","text":"IKibanaSocket"}]},{"id":"def-server.KibanaRequest.events","type":"Object","label":"events","description":["Request events {@link KibanaRequestEvents}"],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":173,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L173"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequestEvents","text":"KibanaRequestEvents"}]},{"id":"def-server.KibanaRequest.auth","type":"Object","label":"auth","description":[],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":174,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L174"},"signature":["{ isAuthenticated: boolean; }"]},{"id":"def-server.KibanaRequest.rewrittenUrl","type":"Object","label":"rewrittenUrl","description":["\nURL rewritten in onPreRouting request interceptor."],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":182,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L182"},"signature":["URL"," | undefined"]},{"id":"def-server.KibanaRequest.[requestSymbol]","type":"Object","label":"[requestSymbol]","description":[],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":185,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L185"},"signature":["Request"]},{"id":"def-server.KibanaRequest.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"request","isRequired":true,"signature":["Request"],"description":[],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":188,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L188"}},{"type":"Uncategorized","label":"params","isRequired":true,"signature":["Params"],"description":[],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":189,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L189"}},{"type":"Uncategorized","label":"query","isRequired":true,"signature":["Query"],"description":[],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":190,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L190"}},{"type":"Uncategorized","label":"body","isRequired":true,"signature":["Body"],"description":[],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":191,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L191"}},{"type":"boolean","label":"withoutSecretHeaders","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":194,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L194"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":187,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L187"}}],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L90"},"initialIsOpen":false},{"id":"def-server.RouteValidationError","type":"Class","label":"RouteValidationError","description":["\nError to return when the validation is not successful."],"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RouteValidationError","text":"RouteValidationError"}," extends ","SchemaTypeError"],"children":[{"id":"def-server.RouteValidationError.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"CompoundType","label":"error","isRequired":true,"signature":["string | Error"],"description":[],"source":{"path":"src/core/server/http/router/validator/validator_error.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator_error.ts#L16"}},{"type":"Array","label":"path","isRequired":true,"signature":["string[]"],"description":[],"source":{"path":"src/core/server/http/router/validator/validator_error.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator_error.ts#L16"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/http/router/validator/validator_error.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator_error.ts#L16"}}],"source":{"path":"src/core/server/http/router/validator/validator_error.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator_error.ts#L15"},"initialIsOpen":false}],"functions":[],"interfaces":[{"id":"def-server.AuthResultParams","type":"Interface","label":"AuthResultParams","description":["\nResult of successful authentication."],"children":[{"id":"def-server.AuthResultParams.state","type":"Object","label":"state","description":["\nData to associate with an incoming request. Any downstream plugin may get access to the data."],"source":{"path":"src/core/server/http/lifecycle/auth.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L92"},"signature":["Record | undefined"]},{"id":"def-server.AuthResultParams.requestHeaders","type":"Object","label":"requestHeaders","description":["\nAuth specific headers to attach to a request object.\nUsed to perform a request to Elasticsearch on behalf of an authenticated user."],"source":{"path":"src/core/server/http/lifecycle/auth.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L97"},"signature":["Record | undefined"]},{"id":"def-server.AuthResultParams.responseHeaders","type":"Object","label":"responseHeaders","description":["\nAuth specific headers to attach to a response object.\nUsed to send back authentication mechanism related headers to a client when needed."],"source":{"path":"src/core/server/http/lifecycle/auth.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L102"},"signature":["Record | undefined"]}],"source":{"path":"src/core/server/http/lifecycle/auth.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L88"},"initialIsOpen":false},{"id":"def-server.AuthToolkit","type":"Interface","label":"AuthToolkit","description":[],"children":[{"id":"def-server.AuthToolkit.authenticated","type":"Function","label":"authenticated","description":["Authentication is successful with given credentials, allow request to pass through"],"source":{"path":"src/core/server/http/lifecycle/auth.ts","lineNumber":123,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L123"},"signature":["(data?: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.AuthResultParams","text":"AuthResultParams"}," | undefined) => ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.AuthResult","text":"AuthResult"}]},{"id":"def-server.AuthToolkit.notHandled","type":"Function","label":"notHandled","description":["\nUser has no credentials.\nAllows user to access a resource when authRequired: 'optional'\nRejects a request when authRequired: true"],"source":{"path":"src/core/server/http/lifecycle/auth.ts","lineNumber":129,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L129"},"signature":["() => ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.AuthResult","text":"AuthResult"}]},{"id":"def-server.AuthToolkit.redirected","type":"Function","label":"redirected","description":["\nRedirects user to another location to complete authentication when authRequired: true\nAllows user to access a resource without redirection when authRequired: 'optional'"],"source":{"path":"src/core/server/http/lifecycle/auth.ts","lineNumber":134,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L134"},"signature":["(headers: ({ location: string; } & Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]>) | ({ location: string; } & Record)) => ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.AuthResult","text":"AuthResult"}]}],"source":{"path":"src/core/server/http/lifecycle/auth.ts","lineNumber":121,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L121"},"initialIsOpen":false},{"id":"def-server.AuthRedirected","type":"Interface","label":"AuthRedirected","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.AuthRedirected","text":"AuthRedirected"}," extends ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.AuthRedirectedParams","text":"AuthRedirectedParams"}],"description":[],"children":[{"id":"def-server.AuthRedirected.type","type":"string","label":"type","description":[],"source":{"path":"src/core/server/http/lifecycle/auth.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L40"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.AuthResultType","text":"AuthResultType"},".redirected"]}],"source":{"path":"src/core/server/http/lifecycle/auth.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L39"},"initialIsOpen":false},{"id":"def-server.AuthRedirectedParams","type":"Interface","label":"AuthRedirectedParams","description":["\nResult of auth redirection."],"children":[{"id":"def-server.AuthRedirectedParams.headers","type":"CompoundType","label":"headers","description":["\nHeaders to attach for auth redirect.\nMust include \"location\" header"],"source":{"path":"src/core/server/http/lifecycle/auth.ts","lineNumber":114,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L114"},"signature":["({ location: string; } & Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]>) | ({ location: string; } & Record)"]}],"source":{"path":"src/core/server/http/lifecycle/auth.ts","lineNumber":109,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L109"},"initialIsOpen":false},{"id":"def-server.Authenticated","type":"Interface","label":"Authenticated","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.Authenticated","text":"Authenticated"}," extends ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.AuthResultParams","text":"AuthResultParams"}],"description":[],"children":[{"id":"def-server.Authenticated.type","type":"string","label":"type","description":[],"source":{"path":"src/core/server/http/lifecycle/auth.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L30"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.AuthResultType","text":"AuthResultType"},".authenticated"]}],"source":{"path":"src/core/server/http/lifecycle/auth.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L29"},"initialIsOpen":false},{"id":"def-server.AuthNotHandled","type":"Interface","label":"AuthNotHandled","description":[],"children":[{"id":"def-server.AuthNotHandled.type","type":"string","label":"type","description":[],"source":{"path":"src/core/server/http/lifecycle/auth.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L35"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.AuthResultType","text":"AuthResultType"},".notHandled"]}],"source":{"path":"src/core/server/http/lifecycle/auth.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L34"},"initialIsOpen":false},{"id":"def-server.CustomHttpResponseOptions","type":"Interface","label":"CustomHttpResponseOptions","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.CustomHttpResponseOptions","text":"CustomHttpResponseOptions"},""],"description":["\nHTTP response parameters for a response with adjustable status code."],"children":[{"id":"def-server.CustomHttpResponseOptions.body","type":"Uncategorized","label":"body","description":["HTTP message to send to the client"],"source":{"path":"src/core/server/http/router/response.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L79"},"signature":["T | undefined"]},{"id":"def-server.CustomHttpResponseOptions.headers","type":"CompoundType","label":"headers","description":["HTTP Headers with additional information about response"],"source":{"path":"src/core/server/http/router/response.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L81"},"signature":["Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]> | Record | undefined"]},{"id":"def-server.CustomHttpResponseOptions.statusCode","type":"number","label":"statusCode","description":[],"source":{"path":"src/core/server/http/router/response.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L82"}}],"source":{"path":"src/core/server/http/router/response.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L77"},"initialIsOpen":false},{"id":"def-server.HttpAuth","type":"Interface","label":"HttpAuth","description":[],"children":[{"id":"def-server.HttpAuth.get","type":"Function","label":"get","description":["\nGets authentication state for a request. Returned by `auth` interceptor.\n{@link GetAuthState}"],"source":{"path":"src/core/server/http/types.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L51"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.GetAuthState","text":"GetAuthState"}]},{"id":"def-server.HttpAuth.isAuthenticated","type":"Function","label":"isAuthenticated","description":["\nReturns authentication status for a request.\n{@link IsAuthenticated}"],"source":{"path":"src/core/server/http/types.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L56"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.IsAuthenticated","text":"IsAuthenticated"}]}],"source":{"path":"src/core/server/http/types.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L46"},"initialIsOpen":false},{"id":"def-server.HttpResponseOptions","type":"Interface","label":"HttpResponseOptions","description":["\nHTTP response parameters"],"children":[{"id":"def-server.HttpResponseOptions.body","type":"CompoundType","label":"body","description":["HTTP message to send to the client"],"source":{"path":"src/core/server/http/router/response.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L62"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.HttpResponsePayload","text":"HttpResponsePayload"}]},{"id":"def-server.HttpResponseOptions.headers","type":"CompoundType","label":"headers","description":["HTTP Headers with additional information about response"],"source":{"path":"src/core/server/http/router/response.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L64"},"signature":["Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]> | Record | undefined"]}],"source":{"path":"src/core/server/http/router/response.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L60"},"initialIsOpen":false},{"id":"def-server.HttpServerInfo","type":"Interface","label":"HttpServerInfo","description":["\nInformation about what hostname, port, and protocol the server process is\nrunning on. Note that this may not match the URL that end-users access\nKibana at. For the public URL, see {@link BasePath.publicBaseUrl}."],"children":[{"id":"def-server.HttpServerInfo.name","type":"string","label":"name","description":["The name of the Kibana server"],"source":{"path":"src/core/server/http/types.ts","lineNumber":336,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L336"}},{"id":"def-server.HttpServerInfo.hostname","type":"string","label":"hostname","description":["The hostname of the server"],"source":{"path":"src/core/server/http/types.ts","lineNumber":338,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L338"}},{"id":"def-server.HttpServerInfo.port","type":"number","label":"port","description":["The port the server is listening on"],"source":{"path":"src/core/server/http/types.ts","lineNumber":340,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L340"}},{"id":"def-server.HttpServerInfo.protocol","type":"CompoundType","label":"protocol","description":["The protocol used by the server"],"source":{"path":"src/core/server/http/types.ts","lineNumber":342,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L342"},"signature":["\"http\" | \"https\" | \"socket\""]}],"source":{"path":"src/core/server/http/types.ts","lineNumber":334,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L334"},"initialIsOpen":false},{"id":"def-server.HttpServiceSetup","type":"Interface","label":"HttpServiceSetup","description":["\nKibana HTTP Service provides own abstraction for work with HTTP stack.\nPlugins don't have direct access to `hapi` server and its primitives anymore. Moreover,\nplugins shouldn't rely on the fact that HTTP Service uses one or another library under the hood.\nThis gives the platform flexibility to upgrade or changing our internal HTTP stack without breaking plugins.\nIf the HTTP Service lacks functionality you need, we are happy to discuss and support your needs.\n"],"children":[{"id":"def-server.HttpServiceSetup.createCookieSessionStorageFactory","type":"Function","label":"createCookieSessionStorageFactory","description":["\nCreates cookie based session storage factory {@link SessionStorageFactory}"],"source":{"path":"src/core/server/http/types.ts","lineNumber":136,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L136"},"signature":["(cookieOptions: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.SessionStorageCookieOptions","text":"SessionStorageCookieOptions"},") => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.SessionStorageFactory","text":"SessionStorageFactory"},">"]},{"id":"def-server.HttpServiceSetup.registerOnPreRouting","type":"Function","label":"registerOnPreRouting","description":["\nTo define custom logic to perform for incoming requests before server performs a route lookup.\n"],"source":{"path":"src/core/server/http/types.ts","lineNumber":150,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L150"},"signature":["(handler: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.OnPreRoutingHandler","text":"OnPreRoutingHandler"},") => void"]},{"id":"def-server.HttpServiceSetup.registerOnPreAuth","type":"Function","label":"registerOnPreAuth","description":["\nTo define custom logic to perform for incoming requests before\nthe Auth interceptor performs a check that user has access to requested resources.\n"],"source":{"path":"src/core/server/http/types.ts","lineNumber":162,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L162"},"signature":["(handler: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.OnPreAuthHandler","text":"OnPreAuthHandler"},") => void"]},{"id":"def-server.HttpServiceSetup.registerAuth","type":"Function","label":"registerAuth","description":["\nTo define custom authentication and/or authorization mechanism for incoming requests.\n"],"source":{"path":"src/core/server/http/types.ts","lineNumber":174,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L174"},"signature":["(handler: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.AuthenticationHandler","text":"AuthenticationHandler"},") => void"]},{"id":"def-server.HttpServiceSetup.registerOnPostAuth","type":"Function","label":"registerOnPostAuth","description":["\nTo define custom logic after Auth interceptor did make sure a user has access to the requested resource.\n"],"source":{"path":"src/core/server/http/types.ts","lineNumber":186,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L186"},"signature":["(handler: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.OnPostAuthHandler","text":"OnPostAuthHandler"},") => void"]},{"id":"def-server.HttpServiceSetup.registerOnPreResponse","type":"Function","label":"registerOnPreResponse","description":["\nTo define custom logic to perform for the server response.\n"],"source":{"path":"src/core/server/http/types.ts","lineNumber":198,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L198"},"signature":["(handler: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.OnPreResponseHandler","text":"OnPreResponseHandler"},") => void"]},{"id":"def-server.HttpServiceSetup.basePath","type":"Object","label":"basePath","description":["\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}."],"source":{"path":"src/core/server/http/types.ts","lineNumber":204,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L204"},"signature":["Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.BasePath","text":"BasePath"},", \"remove\" | \"get\" | \"prepend\" | \"set\" | \"serverBasePath\" | \"publicBaseUrl\">"]},{"id":"def-server.HttpServiceSetup.auth","type":"Object","label":"auth","description":["\nAuth status.\nSee {@link HttpAuth}\n"],"source":{"path":"src/core/server/http/types.ts","lineNumber":212,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L212"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.HttpAuth","text":"HttpAuth"}]},{"id":"def-server.HttpServiceSetup.csp","type":"Object","label":"csp","description":["\nThe CSP config used for Kibana."],"source":{"path":"src/core/server/http/types.ts","lineNumber":217,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L217"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ICspConfig","text":"ICspConfig"}]},{"id":"def-server.HttpServiceSetup.createRouter","type":"Function","label":"createRouter","description":["\nProvides ability to declare a handler function for a particular path and HTTP request method.\n"],"source":{"path":"src/core/server/http/types.ts","lineNumber":234,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L234"},"signature":["() => ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.IRouter","text":"IRouter"},""]},{"id":"def-server.HttpServiceSetup.registerRouteHandlerContext","type":"Function","label":"registerRouteHandlerContext","description":["\nRegister a context provider for a route handler."],"source":{"path":"src/core/server/http/types.ts","lineNumber":266,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L266"},"signature":["(contextName: ContextName, provider: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.IContextProvider","text":"IContextProvider"},") => ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RequestHandlerContextContainer","text":"RequestHandlerContextContainer"}]},{"id":"def-server.HttpServiceSetup.getServerInfo","type":"Function","label":"getServerInfo","description":["\nProvides common {@link HttpServerInfo | information} about the running http server."],"source":{"path":"src/core/server/http/types.ts","lineNumber":277,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L277"},"signature":["() => ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.HttpServerInfo","text":"HttpServerInfo"}]}],"source":{"path":"src/core/server/http/types.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L131"},"initialIsOpen":false},{"id":"def-server.HttpServiceStart","type":"Interface","label":"HttpServiceStart","description":[],"children":[{"id":"def-server.HttpServiceStart.basePath","type":"Object","label":"basePath","description":["\nAccess or manipulate the Kibana base path\nSee {@link IBasePath}."],"source":{"path":"src/core/server/http/types.ts","lineNumber":308,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L308"},"signature":["Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.BasePath","text":"BasePath"},", \"remove\" | \"get\" | \"prepend\" | \"set\" | \"serverBasePath\" | \"publicBaseUrl\">"]},{"id":"def-server.HttpServiceStart.auth","type":"Object","label":"auth","description":["\nAuth status.\nSee {@link HttpAuth}"],"source":{"path":"src/core/server/http/types.ts","lineNumber":314,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L314"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.HttpAuth","text":"HttpAuth"}]},{"id":"def-server.HttpServiceStart.getServerInfo","type":"Function","label":"getServerInfo","description":["\nProvides common {@link HttpServerInfo | information} about the running http server."],"source":{"path":"src/core/server/http/types.ts","lineNumber":319,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L319"},"signature":["() => ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.HttpServerInfo","text":"HttpServerInfo"}]}],"source":{"path":"src/core/server/http/types.ts","lineNumber":303,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L303"},"initialIsOpen":false},{"id":"def-server.ErrorHttpResponseOptions","type":"Interface","label":"ErrorHttpResponseOptions","description":["\nHTTP response parameters"],"children":[{"id":"def-server.ErrorHttpResponseOptions.body","type":"CompoundType","label":"body","description":["HTTP message to send to the client"],"source":{"path":"src/core/server/http/router/response.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L101"},"signature":["string | Error | { message: string | Error; attributes?: Record | undefined; } | undefined"]},{"id":"def-server.ErrorHttpResponseOptions.headers","type":"CompoundType","label":"headers","description":["HTTP Headers with additional information about response"],"source":{"path":"src/core/server/http/router/response.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L103"},"signature":["Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]> | Record | undefined"]}],"source":{"path":"src/core/server/http/router/response.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L99"},"initialIsOpen":false},{"id":"def-server.IKibanaSocket","type":"Interface","label":"IKibanaSocket","description":["\nA tiny abstraction for TCP socket."],"children":[{"id":"def-server.IKibanaSocket.getPeerCertificate","type":"Function","label":"getPeerCertificate","signature":["{ (detailed: true): ","DetailedPeerCertificate"," | null; (detailed: false): ","PeerCertificate"," | null; (detailed?: boolean | undefined): ","DetailedPeerCertificate"," | ","PeerCertificate"," | null; }"],"description":[],"children":[{"type":"boolean","label":"detailed","isRequired":true,"signature":["true"],"description":[],"source":{"path":"src/core/server/http/router/socket.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/socket.ts#L18"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/http/router/socket.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/socket.ts#L18"}},{"id":"def-server.IKibanaSocket.getPeerCertificate","type":"Function","label":"getPeerCertificate","signature":["{ (detailed: true): ","DetailedPeerCertificate"," | null; (detailed: false): ","PeerCertificate"," | null; (detailed?: boolean | undefined): ","DetailedPeerCertificate"," | ","PeerCertificate"," | null; }"],"description":[],"children":[{"type":"boolean","label":"detailed","isRequired":true,"signature":["false"],"description":[],"source":{"path":"src/core/server/http/router/socket.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/socket.ts#L19"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/http/router/socket.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/socket.ts#L19"}},{"id":"def-server.IKibanaSocket.getPeerCertificate","type":"Function","label":"getPeerCertificate","signature":["{ (detailed: true): ","DetailedPeerCertificate"," | null; (detailed: false): ","PeerCertificate"," | null; (detailed?: boolean | undefined): ","DetailedPeerCertificate"," | ","PeerCertificate"," | null; }"],"description":["\nReturns an object representing the peer's certificate.\nThe returned object has some properties corresponding to the field of the certificate.\nIf detailed argument is true the full chain with issuer property will be returned,\nif false only the top certificate without issuer property.\nIf the peer does not provide a certificate, it returns null."],"children":[{"type":"CompoundType","label":"detailed","isRequired":false,"signature":["boolean | undefined"],"description":["- If true; the full chain with issuer property will be returned."],"source":{"path":"src/core/server/http/router/socket.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/socket.ts#L29"}}],"tags":[],"returnComment":["An object representing the peer's certificate."],"source":{"path":"src/core/server/http/router/socket.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/socket.ts#L29"}},{"id":"def-server.IKibanaSocket.getProtocol","type":"Function","label":"getProtocol","signature":["() => string | null"],"description":["\nReturns a string containing the negotiated SSL/TLS protocol version of the current connection. The value 'unknown' will be returned for\nconnected sockets that have not completed the handshaking process. The value null will be returned for server sockets or disconnected\nclient sockets. See https://www.openssl.org/docs/man1.0.2/ssl/SSL_get_version.html for more information."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/server/http/router/socket.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/socket.ts#L36"}},{"id":"def-server.IKibanaSocket.renegotiate","type":"Function","label":"renegotiate","signature":["(options: { rejectUnauthorized?: boolean | undefined; requestCert?: boolean | undefined; }) => Promise"],"description":["\nRenegotiates a connection to obtain the peer's certificate. This cannot be used when the protocol version is TLSv1.3."],"children":[{"id":"def-server.IKibanaSocket.renegotiate.options","type":"Object","label":"options","description":[],"children":[{"id":"def-server.IKibanaSocket.renegotiate.options.rejectUnauthorized","type":"CompoundType","label":"rejectUnauthorized","description":[],"source":{"path":"src/core/server/http/router/socket.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/socket.ts#L43"},"signature":["boolean | undefined"]},{"id":"def-server.IKibanaSocket.renegotiate.options.requestCert","type":"CompoundType","label":"requestCert","description":[],"source":{"path":"src/core/server/http/router/socket.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/socket.ts#L43"},"signature":["boolean | undefined"]}],"source":{"path":"src/core/server/http/router/socket.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/socket.ts#L43"}}],"tags":[],"returnComment":["A Promise that will be resolved if renegotiation succeeded, or will be rejected if renegotiation failed."],"source":{"path":"src/core/server/http/router/socket.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/socket.ts#L43"}},{"id":"def-server.IKibanaSocket.authorized","type":"CompoundType","label":"authorized","description":["\nIndicates whether or not the peer certificate was signed by one of the specified CAs. When TLS\nisn't used the value is `undefined`."],"source":{"path":"src/core/server/http/router/socket.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/socket.ts#L49"},"signature":["boolean | undefined"]},{"id":"def-server.IKibanaSocket.authorizationError","type":"Object","label":"authorizationError","description":["\nThe reason why the peer's certificate has not been verified. This property becomes available\nonly when `authorized` is `false`."],"source":{"path":"src/core/server/http/router/socket.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/socket.ts#L55"},"signature":["Error | undefined"]}],"source":{"path":"src/core/server/http/router/socket.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/socket.ts#L17"},"initialIsOpen":false},{"id":"def-server.KibanaRequestEvents","type":"Interface","label":"KibanaRequestEvents","description":["\nRequest events."],"children":[{"id":"def-server.KibanaRequestEvents.aborted$","type":"Object","label":"aborted$","description":["\nObservable that emits once if and when the request has been aborted."],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L66"},"signature":["Observable",""]},{"id":"def-server.KibanaRequestEvents.completed$","type":"Object","label":"completed$","description":["\nObservable that emits once if and when the request has been completely handled.\n"],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":76,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L76"},"signature":["Observable",""]}],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L62"},"initialIsOpen":false},{"id":"def-server.KibanaRequestRoute","type":"Interface","label":"KibanaRequestRoute","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequestRoute","text":"KibanaRequestRoute"},""],"description":["\nRequest specific route information exposed to a handler."],"children":[{"id":"def-server.KibanaRequestRoute.path","type":"string","label":"path","description":[],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L53"}},{"id":"def-server.KibanaRequestRoute.method","type":"Uncategorized","label":"method","description":[],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L54"},"signature":["Method"]},{"id":"def-server.KibanaRequestRoute.options","type":"Uncategorized","label":"options","description":[],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L55"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequestRouteOptions","text":"KibanaRequestRouteOptions"},""]}],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L52"},"initialIsOpen":false},{"id":"def-server.IKibanaResponse","type":"Interface","label":"IKibanaResponse","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.IKibanaResponse","text":"IKibanaResponse"},""],"description":["\nA response data object, expected to returned as a result of {@link RequestHandler} execution"],"children":[{"id":"def-server.IKibanaResponse.status","type":"number","label":"status","description":[],"source":{"path":"src/core/server/http/router/response.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L34"}},{"id":"def-server.IKibanaResponse.payload","type":"Uncategorized","label":"payload","description":[],"source":{"path":"src/core/server/http/router/response.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L35"},"signature":["T | undefined"]},{"id":"def-server.IKibanaResponse.options","type":"Object","label":"options","description":[],"source":{"path":"src/core/server/http/router/response.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L36"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.HttpResponseOptions","text":"HttpResponseOptions"}]}],"source":{"path":"src/core/server/http/router/response.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L33"},"initialIsOpen":false},{"id":"def-server.LegacyRequest","type":"Interface","label":"LegacyRequest","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.LegacyRequest","text":"LegacyRequest"}," extends ","Request"],"description":[],"children":[],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L84"},"initialIsOpen":false},{"id":"def-server.OnPreAuthToolkit","type":"Interface","label":"OnPreAuthToolkit","description":[],"children":[{"id":"def-server.OnPreAuthToolkit.next","type":"Function","label":"next","description":["To pass request to the next handler"],"source":{"path":"src/core/server/http/lifecycle/on_pre_auth.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_auth.ts#L44"},"signature":["() => Next"]}],"source":{"path":"src/core/server/http/lifecycle/on_pre_auth.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_auth.ts#L42"},"initialIsOpen":false},{"id":"def-server.OnPreRoutingToolkit","type":"Interface","label":"OnPreRoutingToolkit","description":[],"children":[{"id":"def-server.OnPreRoutingToolkit.next","type":"Function","label":"next","description":["To pass request to the next handler"],"source":{"path":"src/core/server/http/lifecycle/on_pre_routing.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_routing.ts#L57"},"signature":["() => OnPreRoutingResult"]},{"id":"def-server.OnPreRoutingToolkit.rewriteUrl","type":"Function","label":"rewriteUrl","description":["Rewrite requested resources url before is was authenticated and routed to a handler"],"source":{"path":"src/core/server/http/lifecycle/on_pre_routing.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_routing.ts#L59"},"signature":["(url: string) => OnPreRoutingResult"]}],"source":{"path":"src/core/server/http/lifecycle/on_pre_routing.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_routing.ts#L55"},"initialIsOpen":false},{"id":"def-server.OnPostAuthToolkit","type":"Interface","label":"OnPostAuthToolkit","description":[],"children":[{"id":"def-server.OnPostAuthToolkit.next","type":"Function","label":"next","description":["To pass request to the next handler"],"source":{"path":"src/core/server/http/lifecycle/on_post_auth.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_post_auth.ts#L44"},"signature":["() => Next"]}],"source":{"path":"src/core/server/http/lifecycle/on_post_auth.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_post_auth.ts#L42"},"initialIsOpen":false},{"id":"def-server.OnPreResponseToolkit","type":"Interface","label":"OnPreResponseToolkit","description":["\nA tool set defining an outcome of OnPreResponse interceptor for incoming request."],"children":[{"id":"def-server.OnPreResponseToolkit.render","type":"Function","label":"render","description":["To override the response with a different body"],"source":{"path":"src/core/server/http/lifecycle/on_pre_response.ts","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_response.ts#L90"},"signature":["(responseRender: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.OnPreResponseRender","text":"OnPreResponseRender"},") => OnPreResponseResult"]},{"id":"def-server.OnPreResponseToolkit.next","type":"Function","label":"next","description":["To pass request to the next handler"],"source":{"path":"src/core/server/http/lifecycle/on_pre_response.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_response.ts#L92"},"signature":["(responseExtensions?: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.OnPreResponseExtensions","text":"OnPreResponseExtensions"}," | undefined) => OnPreResponseResult"]}],"source":{"path":"src/core/server/http/lifecycle/on_pre_response.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_response.ts#L88"},"initialIsOpen":false},{"id":"def-server.OnPreResponseRender","type":"Interface","label":"OnPreResponseRender","description":["\nAdditional data to extend a response when rendering a new body"],"children":[{"id":"def-server.OnPreResponseRender.headers","type":"CompoundType","label":"headers","description":["additional headers to attach to the response"],"source":{"path":"src/core/server/http/lifecycle/on_pre_response.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_response.ts#L47"},"signature":["Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]> | Record | undefined"]},{"id":"def-server.OnPreResponseRender.body","type":"string","label":"body","description":["the body to use in the response"],"source":{"path":"src/core/server/http/lifecycle/on_pre_response.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_response.ts#L49"}}],"source":{"path":"src/core/server/http/lifecycle/on_pre_response.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_response.ts#L45"},"initialIsOpen":false},{"id":"def-server.OnPreResponseExtensions","type":"Interface","label":"OnPreResponseExtensions","description":["\nAdditional data to extend a response."],"children":[{"id":"def-server.OnPreResponseExtensions.headers","type":"CompoundType","label":"headers","description":["additional headers to attach to the response"],"source":{"path":"src/core/server/http/lifecycle/on_pre_response.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_response.ts#L58"},"signature":["Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]> | Record | undefined"]}],"source":{"path":"src/core/server/http/lifecycle/on_pre_response.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_response.ts#L56"},"initialIsOpen":false},{"id":"def-server.OnPreResponseInfo","type":"Interface","label":"OnPreResponseInfo","description":["\nResponse status code."],"children":[{"id":"def-server.OnPreResponseInfo.statusCode","type":"number","label":"statusCode","description":[],"source":{"path":"src/core/server/http/lifecycle/on_pre_response.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_response.ts#L66"}}],"source":{"path":"src/core/server/http/lifecycle/on_pre_response.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_response.ts#L65"},"initialIsOpen":false},{"id":"def-server.RouteConfig","type":"Interface","label":"RouteConfig","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RouteConfig","text":"RouteConfig"},""],"description":["\nRoute specific configuration."],"children":[{"id":"def-server.RouteConfig.path","type":"string","label":"path","description":["\nThe endpoint _within_ the router path to register the route.\n"],"source":{"path":"src/core/server/http/router/route.ts","lineNumber":171,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L171"}},{"id":"def-server.RouteConfig.validate","type":"CompoundType","label":"validate","description":["\nA schema created with `@kbn/config-schema` that every request will be validated against.\n"],"source":{"path":"src/core/server/http/router/route.ts","lineNumber":229,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L229"},"signature":["false | ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RouteValidatorFullConfig","text":"RouteValidatorFullConfig"},""]},{"id":"def-server.RouteConfig.options","type":"Object","label":"options","description":["\nAdditional route options {@link RouteConfigOptions}."],"source":{"path":"src/core/server/http/router/route.ts","lineNumber":234,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L234"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RouteConfigOptions","text":"RouteConfigOptions"}," | undefined"]}],"source":{"path":"src/core/server/http/router/route.ts","lineNumber":157,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L157"},"initialIsOpen":false},{"id":"def-server.IRouter","type":"Interface","label":"IRouter","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.IRouter","text":"IRouter"},""],"description":["\nRegisters route handlers for specified resource path and method.\nSee {@link RouteConfig} and {@link RequestHandler} for more information about arguments to route registrations.\n"],"children":[{"id":"def-server.IRouter.routerPath","type":"string","label":"routerPath","description":["\nResulted path"],"source":{"path":"src/core/server/http/router/router.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/router.ts#L65"}},{"id":"def-server.IRouter.get","type":"Function","label":"get","description":["\nRegister a route handler for `GET` request."],"source":{"path":"src/core/server/http/router/router.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/router.ts#L72"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RouteRegistrar","text":"RouteRegistrar"},"<\"get\", Context>"]},{"id":"def-server.IRouter.post","type":"Function","label":"post","description":["\nRegister a route handler for `POST` request."],"source":{"path":"src/core/server/http/router/router.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/router.ts#L79"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RouteRegistrar","text":"RouteRegistrar"},"<\"post\", Context>"]},{"id":"def-server.IRouter.put","type":"Function","label":"put","description":["\nRegister a route handler for `PUT` request."],"source":{"path":"src/core/server/http/router/router.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/router.ts#L86"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RouteRegistrar","text":"RouteRegistrar"},"<\"put\", Context>"]},{"id":"def-server.IRouter.patch","type":"Function","label":"patch","description":["\nRegister a route handler for `PATCH` request."],"source":{"path":"src/core/server/http/router/router.ts","lineNumber":93,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/router.ts#L93"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RouteRegistrar","text":"RouteRegistrar"},"<\"patch\", Context>"]},{"id":"def-server.IRouter.delete","type":"Function","label":"delete","description":["\nRegister a route handler for `DELETE` request."],"source":{"path":"src/core/server/http/router/router.ts","lineNumber":100,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/router.ts#L100"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RouteRegistrar","text":"RouteRegistrar"},"<\"delete\", Context>"]},{"id":"def-server.IRouter.handleLegacyErrors","type":"Function","label":"handleLegacyErrors","description":["\nWrap a router handler to catch and converts legacy boom errors to proper custom errors."],"source":{"path":"src/core/server/http/router/router.ts","lineNumber":106,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/router.ts#L106"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RequestHandlerWrapper","text":"RequestHandlerWrapper"}]},{"id":"def-server.IRouter.getRoutes","type":"Function","label":"getRoutes","description":["\nReturns all routes registered with this router."],"source":{"path":"src/core/server/http/router/router.ts","lineNumber":113,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/router.ts#L113"},"signature":["() => RouterRoute[]"]}],"source":{"path":"src/core/server/http/router/router.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/router.ts#L61"},"initialIsOpen":false},{"id":"def-server.RouteConfigOptions","type":"Interface","label":"RouteConfigOptions","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RouteConfigOptions","text":"RouteConfigOptions"},""],"description":["\nAdditional route options."],"children":[{"id":"def-server.RouteConfigOptions.authRequired","type":"CompoundType","label":"authRequired","description":["\nDefines authentication mode for a route:\n- true. A user has to have valid credentials to access a resource\n- false. A user can access a resource without any credentials.\n- 'optional'. A user can access a resource if has valid credentials or no credentials at all.\nCan be useful when we grant access to a resource but want to identify a user if possible.\n\nDefaults to `true` if an auth mechanism is registered."],"source":{"path":"src/core/server/http/router/route.ts","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L116"},"signature":["boolean | \"optional\" | undefined"]},{"id":"def-server.RouteConfigOptions.xsrfRequired","type":"Uncategorized","label":"xsrfRequired","description":["\nDefines xsrf protection requirements for a route:\n- true. Requires an incoming POST/PUT/DELETE request to contain `kbn-xsrf` header.\n- false. Disables xsrf protection.\n\nSet to true by default"],"source":{"path":"src/core/server/http/router/route.ts","lineNumber":125,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L125"},"signature":["(Method extends \"get\" ? never : boolean) | undefined"]},{"id":"def-server.RouteConfigOptions.tags","type":"Object","label":"tags","description":["\nAdditional metadata tag strings to attach to the route."],"source":{"path":"src/core/server/http/router/route.ts","lineNumber":130,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L130"},"signature":["readonly string[] | undefined"]},{"id":"def-server.RouteConfigOptions.body","type":"Uncategorized","label":"body","description":["\nAdditional body options {@link RouteConfigOptionsBody}."],"source":{"path":"src/core/server/http/router/route.ts","lineNumber":135,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L135"},"signature":["(Method extends ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.SafeRouteMethod","text":"SafeRouteMethod"}," ? undefined : ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RouteConfigOptionsBody","text":"RouteConfigOptionsBody"},") | undefined"]},{"id":"def-server.RouteConfigOptions.timeout","type":"Object","label":"timeout","description":["\nDefines per-route timeouts."],"source":{"path":"src/core/server/http/router/route.ts","lineNumber":140,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L140"},"signature":["{ payload?: (Method extends ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.SafeRouteMethod","text":"SafeRouteMethod"}," ? undefined : number) | undefined; idleSocket?: number | undefined; } | undefined"]}],"source":{"path":"src/core/server/http/router/route.ts","lineNumber":106,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L106"},"initialIsOpen":false},{"id":"def-server.RouteConfigOptionsBody","type":"Interface","label":"RouteConfigOptionsBody","description":["\nAdditional body options for a route"],"children":[{"id":"def-server.RouteConfigOptionsBody.accepts","type":"CompoundType","label":"accepts","description":["\nA string or an array of strings with the allowed mime types for the endpoint. Use this settings to limit the set of allowed mime types. Note that allowing additional mime types not listed\nabove will not enable them to be parsed, and if parse is true, the request will result in an error response.\n\nDefault value: allows parsing of the following mime types:\n* application/json\n* application/*+json\n* application/octet-stream\n* application/x-www-form-urlencoded\n* multipart/form-data\n* text/*"],"source":{"path":"src/core/server/http/router/route.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L68"},"signature":["string | string[] | ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RouteContentType","text":"RouteContentType"},"[] | undefined"]},{"id":"def-server.RouteConfigOptionsBody.maxBytes","type":"number","label":"maxBytes","description":["\nLimits the size of incoming payloads to the specified byte count. Allowing very large payloads may cause the server to run out of memory.\n\nDefault value: The one set in the kibana.yml config file under the parameter `server.maxPayloadBytes`."],"source":{"path":"src/core/server/http/router/route.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L75"},"signature":["number | undefined"]},{"id":"def-server.RouteConfigOptionsBody.output","type":"CompoundType","label":"output","description":["\nThe processed payload format. The value must be one of:\n* 'data' - the incoming payload is read fully into memory. If parse is true, the payload is parsed (JSON, form-decoded, multipart) based on the 'Content-Type' header. If parse is false, a raw\nBuffer is returned.\n* 'stream' - the incoming payload is made available via a Stream.Readable interface. If the payload is 'multipart/form-data' and parse is true, field values are presented as text while files\nare provided as streams. File streams from a 'multipart/form-data' upload will also have a hapi property containing the filename and headers properties. Note that payload streams for multipart\npayloads are a synthetic interface created on top of the entire multipart content loaded into memory. To avoid loading large multipart payloads into memory, set parse to false and handle the\nmultipart payload in the handler using a streaming parser (e.g. pez).\n\nDefault value: 'data', unless no validation.body is provided in the route definition. In that case the default is 'stream' to alleviate memory pressure."],"source":{"path":"src/core/server/http/router/route.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L88"},"signature":["\"data\" | \"stream\" | undefined"]},{"id":"def-server.RouteConfigOptionsBody.parse","type":"CompoundType","label":"parse","description":["\nDetermines if the incoming payload is processed or presented raw. Available values:\n* true - if the request 'Content-Type' matches the allowed mime types set by allow (for the whole payload as well as parts), the payload is converted into an object when possible. If the\nformat is unknown, a Bad Request (400) error response is sent. Any known content encoding is decoded.\n* false - the raw payload is returned unmodified.\n* 'gunzip' - the raw payload is returned unmodified after any known content encoding is decoded.\n\nDefault value: true, unless no validation.body is provided in the route definition. In that case the default is false to alleviate memory pressure."],"source":{"path":"src/core/server/http/router/route.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L99"},"signature":["boolean | \"gunzip\" | undefined"]}],"source":{"path":"src/core/server/http/router/route.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L55"},"initialIsOpen":false},{"id":"def-server.RouteValidatorConfig","type":"Interface","label":"RouteValidatorConfig","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RouteValidatorConfig","text":"RouteValidatorConfig"},""],"description":["\nThe configuration object to the RouteValidator class.\nSet `params`, `query` and/or `body` to specify the validation logic to follow for that property.\n"],"children":[{"id":"def-server.RouteValidatorConfig.params","type":"CompoundType","label":"params","description":["\nValidation logic for the URL params"],"source":{"path":"src/core/server/http/router/validator/validator.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator.ts#L92"},"signature":["ObjectType"," | ","Type","

| ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RouteValidationFunction","text":"RouteValidationFunction"},"

| undefined"]},{"id":"def-server.RouteValidatorConfig.query","type":"CompoundType","label":"query","description":["\nValidation logic for the Query params"],"source":{"path":"src/core/server/http/router/validator/validator.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator.ts#L97"},"signature":["ObjectType"," | ","Type"," | ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RouteValidationFunction","text":"RouteValidationFunction"}," | undefined"]},{"id":"def-server.RouteValidatorConfig.body","type":"CompoundType","label":"body","description":["\nValidation logic for the body payload"],"source":{"path":"src/core/server/http/router/validator/validator.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator.ts#L102"},"signature":["ObjectType"," | ","Type"," | ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RouteValidationFunction","text":"RouteValidationFunction"}," | undefined"]}],"source":{"path":"src/core/server/http/router/validator/validator.ts","lineNumber":87,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator.ts#L87"},"initialIsOpen":false},{"id":"def-server.RouteValidatorOptions","type":"Interface","label":"RouteValidatorOptions","description":["\nAdditional options for the RouteValidator class to modify its default behaviour.\n"],"children":[{"id":"def-server.RouteValidatorOptions.unsafe","type":"Object","label":"unsafe","description":["\nSet the `unsafe` config to avoid running some additional internal *safe* validations on top of your custom validation"],"source":{"path":"src/core/server/http/router/validator/validator.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator.ts#L115"},"signature":["{ params?: boolean | undefined; query?: boolean | undefined; body?: boolean | undefined; } | undefined"]}],"source":{"path":"src/core/server/http/router/validator/validator.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator.ts#L110"},"initialIsOpen":false},{"id":"def-server.RouteValidationResultFactory","type":"Interface","label":"RouteValidationResultFactory","description":["\nValidation result factory to be used in the custom validation function to return the valid data or validation errors\n\nSee {@link RouteValidationFunction}.\n"],"children":[{"id":"def-server.RouteValidationResultFactory.ok","type":"Function","label":"ok","description":[],"source":{"path":"src/core/server/http/router/validator/validator.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator.ts#L21"},"signature":["(value: T) => { value: T; }"]},{"id":"def-server.RouteValidationResultFactory.badRequest","type":"Function","label":"badRequest","description":[],"source":{"path":"src/core/server/http/router/validator/validator.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator.ts#L22"},"signature":["(error: string | Error, path?: string[] | undefined) => { error: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RouteValidationError","text":"RouteValidationError"},"; }"]}],"source":{"path":"src/core/server/http/router/validator/validator.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator.ts#L20"},"initialIsOpen":false},{"id":"def-server.SessionStorage","type":"Interface","label":"SessionStorage","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.SessionStorage","text":"SessionStorage"},""],"description":["\nProvides an interface to store and retrieve data across requests."],"children":[{"id":"def-server.SessionStorage.get","type":"Function","label":"get","signature":["() => Promise"],"description":["\nRetrieves session value from the session storage."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/server/http/session_storage.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/session_storage.ts#L18"}},{"id":"def-server.SessionStorage.set","type":"Function","label":"set","signature":["(sessionValue: T) => void"],"description":["\nPuts current session value into the session storage."],"children":[{"type":"Uncategorized","label":"sessionValue","isRequired":true,"signature":["T"],"description":["- value to put"],"source":{"path":"src/core/server/http/session_storage.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/session_storage.ts#L23"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/http/session_storage.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/session_storage.ts#L23"}},{"id":"def-server.SessionStorage.clear","type":"Function","label":"clear","signature":["() => void"],"description":["\nClears current session."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/server/http/session_storage.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/session_storage.ts#L27"}}],"source":{"path":"src/core/server/http/session_storage.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/session_storage.ts#L14"},"initialIsOpen":false},{"id":"def-server.SessionStorageCookieOptions","type":"Interface","label":"SessionStorageCookieOptions","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.SessionStorageCookieOptions","text":"SessionStorageCookieOptions"},""],"description":["\nConfiguration used to create HTTP session storage based on top of cookie mechanism."],"children":[{"id":"def-server.SessionStorageCookieOptions.name","type":"string","label":"name","description":["\nName of the session cookie."],"source":{"path":"src/core/server/http/cookie_session_storage.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/cookie_session_storage.ts#L24"}},{"id":"def-server.SessionStorageCookieOptions.encryptionKey","type":"string","label":"encryptionKey","description":["\nA key used to encrypt a cookie's value. Should be at least 32 characters long."],"source":{"path":"src/core/server/http/cookie_session_storage.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/cookie_session_storage.ts#L28"}},{"id":"def-server.SessionStorageCookieOptions.validate","type":"Function","label":"validate","description":["\nFunction called to validate a cookie's decrypted value."],"source":{"path":"src/core/server/http/cookie_session_storage.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/cookie_session_storage.ts#L32"},"signature":["(sessionValue: T | T[]) => ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.SessionCookieValidationResult","text":"SessionCookieValidationResult"}]},{"id":"def-server.SessionStorageCookieOptions.isSecure","type":"boolean","label":"isSecure","description":["\nFlag indicating whether the cookie should be sent only via a secure connection."],"source":{"path":"src/core/server/http/cookie_session_storage.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/cookie_session_storage.ts#L36"}},{"id":"def-server.SessionStorageCookieOptions.sameSite","type":"CompoundType","label":"sameSite","description":["\nDefines SameSite attribute of the Set-Cookie Header.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite"],"source":{"path":"src/core/server/http/cookie_session_storage.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/cookie_session_storage.ts#L41"},"signature":["\"None\" | \"Strict\" | \"Lax\" | undefined"]}],"source":{"path":"src/core/server/http/cookie_session_storage.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/cookie_session_storage.ts#L20"},"initialIsOpen":false},{"id":"def-server.SessionCookieValidationResult","type":"Interface","label":"SessionCookieValidationResult","description":["\nReturn type from a function to validate cookie contents."],"children":[{"id":"def-server.SessionCookieValidationResult.isValid","type":"boolean","label":"isValid","description":["\nWhether the cookie is valid or not."],"source":{"path":"src/core/server/http/cookie_session_storage.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/cookie_session_storage.ts#L52"}},{"id":"def-server.SessionCookieValidationResult.path","type":"string","label":"path","description":["\nThe \"Path\" attribute of the cookie; if the cookie is invalid, this is used to clear it."],"source":{"path":"src/core/server/http/cookie_session_storage.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/cookie_session_storage.ts#L56"},"signature":["string | undefined"]}],"source":{"path":"src/core/server/http/cookie_session_storage.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/cookie_session_storage.ts#L48"},"initialIsOpen":false},{"id":"def-server.SessionStorageFactory","type":"Interface","label":"SessionStorageFactory","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.SessionStorageFactory","text":"SessionStorageFactory"},""],"description":["\nSessionStorage factory to bind one to an incoming request"],"children":[{"id":"def-server.SessionStorageFactory.asScoped","type":"Function","label":"asScoped","description":[],"source":{"path":"src/core/server/http/session_storage.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/session_storage.ts#L34"},"signature":["(request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},") => ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.SessionStorage","text":"SessionStorage"},""]}],"source":{"path":"src/core/server/http/session_storage.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/session_storage.ts#L33"},"initialIsOpen":false}],"enums":[{"id":"def-server.AuthStatus","type":"Enum","label":"AuthStatus","description":["\nStatus indicating an outcome of the authentication."],"source":{"path":"src/core/server/http/auth_state_storage.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/auth_state_storage.ts#L15"},"initialIsOpen":false},{"id":"def-server.AuthResultType","type":"Enum","label":"AuthResultType","description":[],"source":{"path":"src/core/server/http/lifecycle/auth.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L22"},"initialIsOpen":false}],"misc":[{"id":"def-server.AuthenticationHandler","type":"Type","label":"AuthenticationHandler","description":["\nSee {@link AuthToolkit}."],"source":{"path":"src/core/server/http/lifecycle/auth.ts","lineNumber":147,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L147"},"signature":["(request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},", response: { badRequest: (options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.ErrorHttpResponseOptions","text":"ErrorHttpResponseOptions"},") => ","KibanaResponse","<",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.ResponseError","text":"ResponseError"},">; unauthorized: (options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.ErrorHttpResponseOptions","text":"ErrorHttpResponseOptions"}],"initialIsOpen":false},{"id":"def-server.AuthHeaders","type":"Type","label":"AuthHeaders","description":["\nAuth Headers map"],"source":{"path":"src/core/server/http/lifecycle/auth.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L82"},"signature":["{ [x: string]: string | string[]; }"],"initialIsOpen":false},{"id":"def-server.AuthResult","type":"Type","label":"AuthResult","description":[],"source":{"path":"src/core/server/http/lifecycle/auth.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/auth.ts#L44"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.Authenticated","text":"Authenticated"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.AuthNotHandled","text":"AuthNotHandled"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.AuthRedirected","text":"AuthRedirected"}],"initialIsOpen":false},{"id":"def-server.IBasePath","type":"Type","label":"IBasePath","description":["\nAccess or manipulate the Kibana base path\n\n{@link BasePath}"],"source":{"path":"src/core/server/http/base_path_service.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/base_path_service.ts#L104"},"signature":["{ remove: (path: string) => string; get: (request: KibanaRequest | LegacyRequest) => string; prepend: (path: string) => string; set: (request: KibanaRequest | LegacyRequest, requestSpecificBasePath: string) => void; readonly serverBasePath: string; readonly publicBaseUrl?: string | undefined; }"],"initialIsOpen":false},{"id":"def-server.GetAuthHeaders","type":"Type","label":"GetAuthHeaders","description":["\nGet headers to authenticate a user against Elasticsearch."],"source":{"path":"src/core/server/http/auth_headers_storage.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/auth_headers_storage.ts#L18"},"signature":["(request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.LegacyRequest","text":"LegacyRequest"},") => Record | undefined"],"initialIsOpen":false},{"id":"def-server.GetAuthState","type":"Type","label":"GetAuthState","description":["\nGets authentication state for a request. Returned by `auth` interceptor."],"source":{"path":"src/core/server/http/auth_state_storage.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/auth_state_storage.ts#L35"},"signature":["(request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.LegacyRequest","text":"LegacyRequest"},") => { status: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.AuthStatus","text":"AuthStatus"},"; state: T; }"],"initialIsOpen":false},{"id":"def-server.Headers","type":"Type","label":"Headers","description":["\nHttp request headers to read."],"source":{"path":"src/core/server/http/router/headers.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/headers.ts#L40"},"signature":["{ accept?: string | string[] | undefined; \"accept-language\"?: string | string[] | undefined; \"accept-patch\"?: string | string[] | undefined; \"accept-ranges\"?: string | string[] | undefined; \"access-control-allow-credentials\"?: string | string[] | undefined; \"access-control-allow-headers\"?: string | string[] | undefined; \"access-control-allow-methods\"?: string | string[] | undefined; \"access-control-allow-origin\"?: string | string[] | undefined; \"access-control-expose-headers\"?: string | string[] | undefined; \"access-control-max-age\"?: string | string[] | undefined; \"access-control-request-headers\"?: string | string[] | undefined; \"access-control-request-method\"?: string | string[] | undefined; age?: string | string[] | undefined; allow?: string | string[] | undefined; \"alt-svc\"?: string | string[] | undefined; authorization?: string | string[] | undefined; \"cache-control\"?: string | string[] | undefined; connection?: string | string[] | undefined; \"content-disposition\"?: string | string[] | undefined; \"content-encoding\"?: string | string[] | undefined; \"content-language\"?: string | string[] | undefined; \"content-length\"?: string | string[] | undefined; \"content-location\"?: string | string[] | undefined; \"content-range\"?: string | string[] | undefined; \"content-type\"?: string | string[] | undefined; cookie?: string | string[] | undefined; date?: string | string[] | undefined; expect?: string | string[] | undefined; expires?: string | string[] | undefined; forwarded?: string | string[] | undefined; from?: string | string[] | undefined; host?: string | string[] | undefined; \"if-match\"?: string | string[] | undefined; \"if-modified-since\"?: string | string[] | undefined; \"if-none-match\"?: string | string[] | undefined; \"if-unmodified-since\"?: string | string[] | undefined; \"last-modified\"?: string | string[] | undefined; location?: string | string[] | undefined; origin?: string | string[] | undefined; pragma?: string | string[] | undefined; \"proxy-authenticate\"?: string | string[] | undefined; \"proxy-authorization\"?: string | string[] | undefined; \"public-key-pins\"?: string | string[] | undefined; range?: string | string[] | undefined; referer?: string | string[] | undefined; \"retry-after\"?: string | string[] | undefined; \"sec-websocket-accept\"?: string | string[] | undefined; \"sec-websocket-extensions\"?: string | string[] | undefined; \"sec-websocket-key\"?: string | string[] | undefined; \"sec-websocket-protocol\"?: string | string[] | undefined; \"sec-websocket-version\"?: string | string[] | undefined; \"set-cookie\"?: string | string[] | undefined; \"strict-transport-security\"?: string | string[] | undefined; tk?: string | string[] | undefined; trailer?: string | string[] | undefined; \"transfer-encoding\"?: string | string[] | undefined; upgrade?: string | string[] | undefined; \"user-agent\"?: string | string[] | undefined; vary?: string | string[] | undefined; via?: string | string[] | undefined; warning?: string | string[] | undefined; \"www-authenticate\"?: string | string[] | undefined; } & { [header: string]: string | string[] | undefined; }"],"initialIsOpen":false},{"id":"def-server.HttpResponsePayload","type":"Type","label":"HttpResponsePayload","description":["\nData send to the client as a response payload."],"source":{"path":"src/core/server/http/router/response.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L71"},"signature":["undefined | string | Record | Buffer | ","Stream"],"initialIsOpen":false},{"id":"def-server.IsAuthenticated","type":"Type","label":"IsAuthenticated","description":["\nReturns authentication status for a request."],"source":{"path":"src/core/server/http/auth_state_storage.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/auth_state_storage.ts#L44"},"signature":["(request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.LegacyRequest","text":"LegacyRequest"},") => boolean"],"initialIsOpen":false},{"id":"def-server.KibanaRequestRouteOptions","type":"Type","label":"KibanaRequestRouteOptions","description":["\nRoute options: If 'GET' or 'OPTIONS' method, body options won't be returned."],"source":{"path":"src/core/server/http/router/request.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/request.ts#L44"},"signature":["Method extends ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.SafeRouteMethod","text":"SafeRouteMethod"}," ? Required, \"timeout\" | \"tags\" | \"authRequired\" | \"xsrfRequired\">> : Required>"],"initialIsOpen":false},{"id":"def-server.LifecycleResponseFactory","type":"Type","label":"LifecycleResponseFactory","description":["\nCreates an object containing redirection or error response with error details, HTTP headers, and other data transmitted to the client."],"source":{"path":"src/core/server/http/router/response.ts","lineNumber":325,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L325"},"signature":["{ badRequest: (options?: ErrorHttpResponseOptions) => KibanaResponse; unauthorized: (options?: ErrorHttpResponseOptions) => KibanaResponse; forbidden: (options?: ErrorHttpResponseOptions) => KibanaResponse; notFound: (options?: ErrorHttpResponseOptions) => KibanaResponse; conflict: (options?: ErrorHttpResponseOptions) => KibanaResponse; customError: (options: CustomHttpResponseOptions) => KibanaResponse; redirected: (options: RedirectResponseOptions) => KibanaResponse | Buffer | Stream>; }"],"initialIsOpen":false},{"id":"def-server.KnownHeaders","type":"Type","label":"KnownHeaders","description":["\nSet of well-known HTTP headers."],"source":{"path":"src/core/server/http/router/headers.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/headers.ts#L34"},"signature":["\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\""],"initialIsOpen":false},{"id":"def-server.OnPreAuthHandler","type":"Type","label":"OnPreAuthHandler","description":["\nSee {@link OnPreAuthToolkit}."],"source":{"path":"src/core/server/http/lifecycle/on_pre_auth.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_auth.ts#L55"},"signature":["(request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},", response: { badRequest: (options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.ErrorHttpResponseOptions","text":"ErrorHttpResponseOptions"},") => ","KibanaResponse","<",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.ResponseError","text":"ResponseError"},">; unauthorized: (options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.ErrorHttpResponseOptions","text":"ErrorHttpResponseOptions"}],"initialIsOpen":false},{"id":"def-server.OnPreRoutingHandler","type":"Type","label":"OnPreRoutingHandler","description":["\nSee {@link OnPreRoutingToolkit}."],"source":{"path":"src/core/server/http/lifecycle/on_pre_routing.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_routing.ts#L71"},"signature":["(request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},", response: { badRequest: (options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.ErrorHttpResponseOptions","text":"ErrorHttpResponseOptions"},") => ","KibanaResponse","<",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.ResponseError","text":"ResponseError"},">; unauthorized: (options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.ErrorHttpResponseOptions","text":"ErrorHttpResponseOptions"}],"initialIsOpen":false},{"id":"def-server.OnPostAuthHandler","type":"Type","label":"OnPostAuthHandler","description":["\nSee {@link OnPostAuthToolkit}."],"source":{"path":"src/core/server/http/lifecycle/on_post_auth.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_post_auth.ts#L51"},"signature":["(request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},", response: { badRequest: (options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.ErrorHttpResponseOptions","text":"ErrorHttpResponseOptions"},") => ","KibanaResponse","<",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.ResponseError","text":"ResponseError"},">; unauthorized: (options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.ErrorHttpResponseOptions","text":"ErrorHttpResponseOptions"}],"initialIsOpen":false},{"id":"def-server.OnPreResponseHandler","type":"Type","label":"OnPreResponseHandler","description":["\nSee {@link OnPreRoutingToolkit}."],"source":{"path":"src/core/server/http/lifecycle/on_pre_response.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/lifecycle/on_pre_response.ts#L104"},"signature":["(request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},", preResponse: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.OnPreResponseInfo","text":"OnPreResponseInfo"},", toolkit: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.OnPreResponseToolkit","text":"OnPreResponseToolkit"},") => Render | Next | Promise"],"initialIsOpen":false},{"id":"def-server.RedirectResponseOptions","type":"Type","label":"RedirectResponseOptions","description":["\nHTTP response parameters for redirection response"],"source":{"path":"src/core/server/http/router/response.ts","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L89"},"signature":["HttpResponseOptions & { headers: { location: string;}; }"],"initialIsOpen":false},{"id":"def-server.RequestHandler","type":"Type","label":"RequestHandler","description":["\nA function executed when route path matched requested resource path.\nRequest handler is expected to return a result of one of {@link KibanaResponseFactory} functions.\nIf anything else is returned, or an error is thrown, the HTTP service will automatically log the error\nand respond `500 - Internal Server Error`."],"source":{"path":"src/core/server/http/router/router.ts","lineNumber":350,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/router.ts#L350"},"signature":["(context: Context, request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},", response: ResponseFactory) => ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.IKibanaResponse","text":"IKibanaResponse"}," | Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.IKibanaResponse","text":"IKibanaResponse"},">"],"initialIsOpen":false},{"id":"def-server.RequestHandlerWrapper","type":"Type","label":"RequestHandlerWrapper","description":["\nType-safe wrapper for {@link RequestHandler} function."],"source":{"path":"src/core/server/http/router/router.ts","lineNumber":376,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/router.ts#L376"},"signature":["(handler: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RequestHandler","text":"RequestHandler"},") => ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RequestHandler","text":"RequestHandler"},""],"initialIsOpen":false},{"id":"def-server.RequestHandlerContextContainer","type":"Type","label":"RequestHandlerContextContainer","description":["\nAn object that handles registration of http request context providers."],"source":{"path":"src/core/server/http/types.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L30"},"signature":["IContextContainer | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ","Stream"," | undefined>(options: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CustomHttpResponseOptions","text":"CustomHttpResponseOptions"},") => ","KibanaResponse","; badRequest: (options?: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ErrorHttpResponseOptions","text":"ErrorHttpResponseOptions"},") => ","KibanaResponse"],"initialIsOpen":false},{"id":"def-server.RequestHandlerContextProvider","type":"Type","label":"RequestHandlerContextProvider","description":["\nContext provider for request handler.\nExtends request context object with provided functionality or data.\n"],"source":{"path":"src/core/server/http/types.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/types.ts#L38"},"signature":["(context: Pick>, rest: [request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},", response: { custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ","Stream"," | undefined>(options: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.CustomHttpResponseOptions","text":"CustomHttpResponseOptions"},") => ","KibanaResponse","; badRequest: (options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.ErrorHttpResponseOptions","text":"ErrorHttpResponseOptions"}],"initialIsOpen":false},{"id":"def-server.ResponseError","type":"Type","label":"ResponseError","description":["\nError message and optional data send to the client in case of error."],"source":{"path":"src/core/server/http/router/response.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L21"},"signature":["string | Error | { message: string | Error; attributes?: Record | undefined; }"],"initialIsOpen":false},{"id":"def-server.ResponseErrorAttributes","type":"Type","label":"ResponseErrorAttributes","description":["\nAdditional data to provide error details."],"source":{"path":"src/core/server/http/router/response.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L16"},"signature":["{ [x: string]: any; }"],"initialIsOpen":false},{"id":"def-server.ResponseHeaders","type":"Type","label":"ResponseHeaders","description":["\nHttp response headers to set."],"source":{"path":"src/core/server/http/router/headers.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/headers.ts#L48"},"signature":["Record<\"accept\" | \"accept-language\" | \"accept-patch\" | \"accept-ranges\" | \"access-control-allow-credentials\" | \"access-control-allow-headers\" | \"access-control-allow-methods\" | \"access-control-allow-origin\" | \"access-control-expose-headers\" | \"access-control-max-age\" | \"access-control-request-headers\" | \"access-control-request-method\" | \"age\" | \"allow\" | \"alt-svc\" | \"authorization\" | \"cache-control\" | \"connection\" | \"content-disposition\" | \"content-encoding\" | \"content-language\" | \"content-length\" | \"content-location\" | \"content-range\" | \"content-type\" | \"cookie\" | \"date\" | \"expect\" | \"expires\" | \"forwarded\" | \"from\" | \"host\" | \"if-match\" | \"if-modified-since\" | \"if-none-match\" | \"if-unmodified-since\" | \"last-modified\" | \"location\" | \"origin\" | \"pragma\" | \"proxy-authenticate\" | \"proxy-authorization\" | \"public-key-pins\" | \"range\" | \"referer\" | \"retry-after\" | \"sec-websocket-accept\" | \"sec-websocket-extensions\" | \"sec-websocket-key\" | \"sec-websocket-protocol\" | \"sec-websocket-version\" | \"set-cookie\" | \"strict-transport-security\" | \"tk\" | \"trailer\" | \"transfer-encoding\" | \"upgrade\" | \"user-agent\" | \"vary\" | \"via\" | \"warning\" | \"www-authenticate\", string | string[]> | Record"],"initialIsOpen":false},{"id":"def-server.KibanaResponseFactory","type":"Type","label":"KibanaResponseFactory","description":["\nCreates an object containing request response payload, HTTP headers, error details, and other data transmitted to the client."],"source":{"path":"src/core/server/http/router/response.ts","lineNumber":319,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L319"},"signature":["{ custom: | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | Stream | undefined>(options: CustomHttpResponseOptions) => KibanaResponse; badRequest: (options?: ErrorHttpResponseOptions) => KibanaResponse; unauthorized: (options?: ErrorHttpResponseOptions) => KibanaResponse; forbidden: (options?: ErrorHttpResponseOptions) => KibanaResponse; notFound: (options?: ErrorHttpResponseOptions) => KibanaResponse; conflict: (options?: ErrorHttpResponseOptions) => KibanaResponse; customError: (options: CustomHttpResponseOptions) => KibanaResponse; redirected: (options: RedirectResponseOptions) => KibanaResponse | Buffer | Stream>; ok: (options?: HttpResponseOptions) => KibanaResponse | Buffer | Stream>; accepted: (options?: HttpResponseOptions) => KibanaResponse | Buffer | Stream>; noContent: (options?: HttpResponseOptions) => KibanaResponse; }"],"initialIsOpen":false},{"id":"def-server.RouteRegistrar","type":"Type","label":"RouteRegistrar","description":["\nRoute handler common definition\n"],"source":{"path":"src/core/server/http/router/router.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/router.ts#L47"},"signature":["(route: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RouteConfig","text":"RouteConfig"},", handler: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RequestHandler","text":"RequestHandler"}," | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ","Stream"," | undefined>(options: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.CustomHttpResponseOptions","text":"CustomHttpResponseOptions"},") => ","KibanaResponse"],"initialIsOpen":false},{"id":"def-server.RouteMethod","type":"Type","label":"RouteMethod","description":["\nThe set of common HTTP methods supported by Kibana routing."],"source":{"path":"src/core/server/http/router/route.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L31"},"signature":["\"get\" | \"options\" | \"post\" | \"put\" | \"delete\" | \"patch\""],"initialIsOpen":false},{"id":"def-server.RouteContentType","type":"Type","label":"RouteContentType","description":["\nThe set of supported parseable Content-Types"],"source":{"path":"src/core/server/http/router/route.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L43"},"signature":["\"application/json\" | \"application/*+json\" | \"application/octet-stream\" | \"application/x-www-form-urlencoded\" | \"multipart/form-data\" | \"text/*\""],"initialIsOpen":false},{"id":"def-server.RouteValidationSpec","type":"Type","label":"RouteValidationSpec","description":["\nAllowed property validation options: either @kbn/config-schema validations or custom validation functions\n\nSee {@link RouteValidationFunction} for custom validation.\n"],"source":{"path":"src/core/server/http/router/validator/validator.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator.ts#L70"},"signature":["ObjectType"," | ","Type"," | ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RouteValidationFunction","text":"RouteValidationFunction"},""],"initialIsOpen":false},{"id":"def-server.RouteValidationFunction","type":"Type","label":"RouteValidationFunction","description":["\nThe custom validation function if @kbn/config-schema is not a valid solution for your specific plugin requirements.\n"],"source":{"path":"src/core/server/http/router/validator/validator.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator.ts#L50"},"signature":["(data: any, validationResult: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RouteValidationResultFactory","text":"RouteValidationResultFactory"},") => { value: T; error?: undefined; } | { value?: undefined; error: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.RouteValidationError","text":"RouteValidationError"},"; }"],"initialIsOpen":false},{"id":"def-server.RouteValidatorFullConfig","type":"Type","label":"RouteValidatorFullConfig","description":["\nRoute validations config and options merged into one object"],"source":{"path":"src/core/server/http/router/validator/validator.ts","lineNumber":126,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/validator/validator.ts#L126"},"signature":["RouteValidatorConfig & RouteValidatorOptions"],"initialIsOpen":false},{"id":"def-server.DestructiveRouteMethod","type":"Type","label":"DestructiveRouteMethod","description":["\nSet of HTTP methods changing the state of the server."],"source":{"path":"src/core/server/http/router/route.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L19"},"signature":["\"post\" | \"put\" | \"delete\" | \"patch\""],"initialIsOpen":false},{"id":"def-server.SafeRouteMethod","type":"Type","label":"SafeRouteMethod","description":["\nSet of HTTP methods not changing the state of the server."],"source":{"path":"src/core/server/http/router/route.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L25"},"signature":["\"get\" | \"options\""],"initialIsOpen":false}],"objects":[{"id":"def-server.kibanaResponseFactory","type":"Object","children":[{"id":"def-server.kibanaResponseFactory.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/http/router/response.ts","lineNumber":290,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L290"},"signature":["any"]},{"id":"def-server.kibanaResponseFactory.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/http/router/response.ts","lineNumber":291,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L291"},"signature":["any"]},{"id":"def-server.kibanaResponseFactory.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/http/router/response.ts","lineNumber":292,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L292"},"signature":["any"]},{"id":"def-server.kibanaResponseFactory.custom","type":"Function","children":[{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.CustomHttpResponseOptions","text":"CustomHttpResponseOptions"},""],"description":[],"source":{"path":"src/core/server/http/router/response.ts","lineNumber":298,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L298"}}],"signature":[" | Error | { message: string | Error; attributes?: Record | undefined; } | Buffer | ","Stream"," | undefined>(options: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.CustomHttpResponseOptions","text":"CustomHttpResponseOptions"},") => ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaResponse","text":"KibanaResponse"},""],"description":["/**\n * Creates a response with defined status code and payload.\n * @param options - {@link CustomHttpResponseOptions} configures HTTP response parameters.\n */"],"label":"custom","source":{"path":"src/core/server/http/router/response.ts","lineNumber":297,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L297"},"returnComment":[]}],"description":["\nSet of helpers used to create `KibanaResponse` to form HTTP response on an incoming request.\nShould be returned as a result of {@link RequestHandler} execution.\n"],"label":"kibanaResponseFactory","source":{"path":"src/core/server/http/router/response.ts","lineNumber":289,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/response.ts#L289"},"initialIsOpen":false},{"id":"def-server.validBodyOutput","type":"Object","label":"validBodyOutput","description":["\nThe set of valid body.output"],"source":{"path":"src/core/server/http/router/route.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/http/router/route.ts#L37"},"signature":["readonly [\"data\", \"stream\"]"],"initialIsOpen":false}]},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]}} \ No newline at end of file diff --git a/api_docs/core_http.mdx b/api_docs/core_http.mdx new file mode 100644 index 0000000000000..ca8adc8e42cf2 --- /dev/null +++ b/api_docs/core_http.mdx @@ -0,0 +1,32 @@ +--- +id: kibCoreHttpPluginApi +slug: /kibana-dev-docs/core.httpPluginApi +title: core.http +image: https://source.unsplash.com/400x175/?github +summary: API docs for the core.http plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.http'] +--- + +import coreHttpObj from './core_http.json'; + +## Client + +### Classes + +### Interfaces + +### Consts, variables and types + +## Server + +### Objects + +### Classes + +### Interfaces + +### Enums + +### Consts, variables and types + diff --git a/api_docs/core_saved_objects.json b/api_docs/core_saved_objects.json new file mode 100644 index 0000000000000..c843ecfbcb4d1 --- /dev/null +++ b/api_docs/core_saved_objects.json @@ -0,0 +1 @@ +{"id":"core.savedObjects","client":{"classes":[{"id":"def-public.SavedObjectsClient","type":"Class","label":"SavedObjectsClient","description":["\nSaved Objects is Kibana's data persisentence mechanism allowing plugins to\nuse Elasticsearch for storing plugin state. The client-side\nSavedObjectsClient is a thin convenience library around the SavedObjects\nHTTP API for interacting with Saved Objects.\n"],"children":[{"id":"def-public.SavedObjectsClient.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"http","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpSetup","text":"HttpSetup"}],"description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":207,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L207"}}],"tags":["internal"],"returnComment":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":207,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L207"}},{"id":"def-public.SavedObjectsClient.create","type":"Function","children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":221,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L221"}},{"type":"Uncategorized","label":"attributes","isRequired":true,"signature":["T"],"description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":222,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L222"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SavedObjectsCreateOptions","text":"SavedObjectsCreateOptions"}],"description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":223,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L223"}}],"signature":["(type: string, attributes: T, options?: ",{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SavedObjectsCreateOptions","text":"SavedObjectsCreateOptions"},") => Promise<",{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SimpleSavedObject","text":"SimpleSavedObject"},">"],"description":["\nPersists an object\n"],"label":"create","source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":220,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L220"},"returnComment":[]},{"id":"def-public.SavedObjectsClient.bulkCreate","type":"Function","children":[{"type":"Array","label":"objects","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SavedObjectsBulkCreateObject","text":"SavedObjectsBulkCreateObject"},"[]"],"description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":256,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L256"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SavedObjectsBulkCreateOptions","text":"SavedObjectsBulkCreateOptions"}],"description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":257,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L257"}}],"signature":["(objects?: ",{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SavedObjectsBulkCreateObject","text":"SavedObjectsBulkCreateObject"},"[], options?: ",{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SavedObjectsBulkCreateOptions","text":"SavedObjectsBulkCreateOptions"},") => Promise<",{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SavedObjectsBatchResponse","text":"SavedObjectsBatchResponse"},">"],"description":["\nCreates multiple documents at once\n"],"label":"bulkCreate","source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":255,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L255"},"returnComment":["The result of the create operation containing created saved objects."]},{"id":"def-public.SavedObjectsClient.delete","type":"Function","children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":284,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L284"}},{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":285,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L285"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SavedObjectsDeleteOptions","text":"SavedObjectsDeleteOptions"}," | undefined"],"description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":286,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L286"}}],"signature":["(type: string, id: string, options?: ",{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SavedObjectsDeleteOptions","text":"SavedObjectsDeleteOptions"}," | undefined) => Promise<{}>"],"description":["\nDeletes an object\n"],"label":"delete","source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":283,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L283"},"returnComment":[]},{"id":"def-public.SavedObjectsClient.find","type":"Function","children":[{"type":"Object","label":"options","isRequired":true,"signature":["Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsFindOptions","text":"SavedObjectsFindOptions"},", \"type\" | \"filter\" | \"fields\" | \"search\" | \"page\" | \"perPage\" | \"sortField\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"preference\">"],"description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":314,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L314"}}],"signature":["(options: Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsFindOptions","text":"SavedObjectsFindOptions"},", \"type\" | \"filter\" | \"fields\" | \"search\" | \"page\" | \"perPage\" | \"sortField\" | \"searchFields\" | \"hasReference\" | \"hasReferenceOperator\" | \"defaultSearchOperator\" | \"namespaces\" | \"preference\">) => Promise<",{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SavedObjectsFindResponsePublic","text":"SavedObjectsFindResponsePublic"},">"],"description":["\nSearch for objects\n"],"label":"find","source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":313,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L313"},"returnComment":["A find result with objects matching the specified search."]},{"id":"def-public.SavedObjectsClient.get","type":"Function","children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":372,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L372"}},{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":372,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L372"}}],"signature":["(type: string, id: string) => Promise<",{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SimpleSavedObject","text":"SimpleSavedObject"},">"],"description":["\nFetches a single object\n"],"label":"get","source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":372,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L372"},"returnComment":["The saved object for the given type and id."]},{"id":"def-public.SavedObjectsClient.bulkGet","type":"Function","children":[{"type":"Array","label":"objects","isRequired":true,"signature":["{ id: string; type: string; }[]"],"description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":395,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L395"}}],"signature":["(objects?: { id: string; type: string; }[]) => Promise<",{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SavedObjectsBatchResponse","text":"SavedObjectsBatchResponse"},">"],"description":["\nReturns an array of objects by id\n"],"label":"bulkGet","source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":395,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L395"},"returnComment":["The saved objects with the given type and ids requested"]},{"id":"def-public.SavedObjectsClient.update","type":"Function","label":"update","signature":["(type: string, id: string, attributes: T, { version, migrationVersion, references }?: ",{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SavedObjectsUpdateOptions","text":"SavedObjectsUpdateOptions"},") => Promise<",{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SimpleSavedObject","text":"SimpleSavedObject"},">"],"description":["\nUpdates an object\n"],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":427,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L427"}},{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":428,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L428"}},{"type":"Uncategorized","label":"attributes","isRequired":true,"signature":["T"],"description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":429,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L429"}},{"type":"Object","label":"{ version, migrationVersion, references }","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SavedObjectsUpdateOptions","text":"SavedObjectsUpdateOptions"}],"description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":430,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L430"}}],"tags":["prop","prop"],"returnComment":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":426,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L426"}},{"id":"def-public.SavedObjectsClient.bulkUpdate","type":"Function","label":"bulkUpdate","signature":["(objects?: ",{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SavedObjectsBulkUpdateObject","text":"SavedObjectsBulkUpdateObject"},"[]) => Promise<",{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SavedObjectsBatchResponse","text":"SavedObjectsBatchResponse"},">"],"description":["\nUpdate multiple documents at once\n"],"children":[{"type":"Array","label":"objects","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SavedObjectsBulkUpdateObject","text":"SavedObjectsBulkUpdateObject"},"[]"],"description":["- [{ type, id, attributes, options: { version, references } }]"],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":458,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L458"}}],"tags":[],"returnComment":["The result of the update operation containing both failed and updated saved objects."],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":458,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L458"}}],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":165,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L165"},"initialIsOpen":false},{"id":"def-public.SimpleSavedObject","type":"Class","label":"SimpleSavedObject","description":["\nThis class is a very simple wrapper for SavedObjects loaded from the server\nwith the {@link SavedObjectsClient}.\n\nIt provides basic functionality for creating/saving/deleting saved objects,\nbut doesn't include any type-specific implementations.\n"],"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SimpleSavedObject","text":"SimpleSavedObject"},""],"children":[{"id":"def-public.SimpleSavedObject.attributes","type":"Uncategorized","label":"attributes","description":[],"source":{"path":"src/core/public/saved_objects/simple_saved_object.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L24"},"signature":["T"]},{"id":"def-public.SimpleSavedObject._version","type":"string","label":"_version","description":[],"source":{"path":"src/core/public/saved_objects/simple_saved_object.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L26"},"signature":["string | undefined"]},{"id":"def-public.SimpleSavedObject.id","type":"string","label":"id","description":[],"source":{"path":"src/core/public/saved_objects/simple_saved_object.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L27"}},{"id":"def-public.SimpleSavedObject.type","type":"string","label":"type","description":[],"source":{"path":"src/core/public/saved_objects/simple_saved_object.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L28"}},{"id":"def-public.SimpleSavedObject.migrationVersion","type":"Object","label":"migrationVersion","description":[],"source":{"path":"src/core/public/saved_objects/simple_saved_object.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L29"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectsMigrationVersion","text":"SavedObjectsMigrationVersion"}," | undefined"]},{"id":"def-public.SimpleSavedObject.coreMigrationVersion","type":"string","label":"coreMigrationVersion","description":[],"source":{"path":"src/core/public/saved_objects/simple_saved_object.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L30"},"signature":["string | undefined"]},{"id":"def-public.SimpleSavedObject.error","type":"Object","label":"error","description":[],"source":{"path":"src/core/public/saved_objects/simple_saved_object.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L31"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectError","text":"SavedObjectError"}," | undefined"]},{"id":"def-public.SimpleSavedObject.references","type":"Array","label":"references","description":[],"source":{"path":"src/core/public/saved_objects/simple_saved_object.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L32"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[]"]},{"id":"def-public.SimpleSavedObject.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"client","isRequired":true,"signature":["Pick<",{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\">"],"description":[],"source":{"path":"src/core/public/saved_objects/simple_saved_object.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L35"}},{"type":"Object","label":"{\n id,\n type,\n version,\n attributes,\n error,\n references,\n migrationVersion,\n coreMigrationVersion,\n }","isRequired":true,"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},""],"description":[],"source":{"path":"src/core/public/saved_objects/simple_saved_object.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L36"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/saved_objects/simple_saved_object.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L34"}},{"id":"def-public.SimpleSavedObject.get","type":"Function","label":"get","signature":["(key: string) => any"],"description":[],"children":[{"type":"string","label":"key","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/public/saved_objects/simple_saved_object.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L59"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/saved_objects/simple_saved_object.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L59"}},{"id":"def-public.SimpleSavedObject.set","type":"Function","label":"set","signature":["(key: string, value: any) => T"],"description":[],"children":[{"type":"string","label":"key","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/public/saved_objects/simple_saved_object.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L63"}},{"type":"Any","label":"value","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/core/public/saved_objects/simple_saved_object.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L63"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/saved_objects/simple_saved_object.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L63"}},{"id":"def-public.SimpleSavedObject.has","type":"Function","label":"has","signature":["(key: string) => boolean"],"description":[],"children":[{"type":"string","label":"key","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/public/saved_objects/simple_saved_object.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L67"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/public/saved_objects/simple_saved_object.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L67"}},{"id":"def-public.SimpleSavedObject.save","type":"Function","label":"save","signature":["() => Promise<",{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SimpleSavedObject","text":"SimpleSavedObject"},">"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/public/saved_objects/simple_saved_object.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L71"}},{"id":"def-public.SimpleSavedObject.delete","type":"Function","label":"delete","signature":["() => Promise<{}>"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/public/saved_objects/simple_saved_object.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L86"}}],"source":{"path":"src/core/public/saved_objects/simple_saved_object.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/simple_saved_object.ts#L23"},"initialIsOpen":false}],"functions":[],"interfaces":[{"id":"def-public.SavedObjectsBatchResponse","type":"Interface","label":"SavedObjectsBatchResponse","signature":[{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SavedObjectsBatchResponse","text":"SavedObjectsBatchResponse"},""],"description":[],"children":[{"id":"def-public.SavedObjectsBatchResponse.savedObjects","type":"Array","label":"savedObjects","description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L89"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SimpleSavedObject","text":"SimpleSavedObject"},"[]"]}],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L88"},"initialIsOpen":false},{"id":"def-public.SavedObjectsBulkCreateObject","type":"Interface","label":"SavedObjectsBulkCreateObject","signature":[{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SavedObjectsBulkCreateObject","text":"SavedObjectsBulkCreateObject"}," extends ",{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SavedObjectsCreateOptions","text":"SavedObjectsCreateOptions"}],"description":[],"children":[{"id":"def-public.SavedObjectsBulkCreateObject.type","type":"string","label":"type","description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L55"}},{"id":"def-public.SavedObjectsBulkCreateObject.attributes","type":"Uncategorized","label":"attributes","description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L56"},"signature":["T"]}],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L54"},"initialIsOpen":false},{"id":"def-public.SavedObjectsBulkCreateOptions","type":"Interface","label":"SavedObjectsBulkCreateOptions","description":[],"children":[{"id":"def-public.SavedObjectsBulkCreateOptions.overwrite","type":"CompoundType","label":"overwrite","description":["If a document with the given `id` already exists, overwrite it's contents (default=false)."],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L62"},"signature":["boolean | undefined"]}],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L60"},"initialIsOpen":false},{"id":"def-public.SavedObjectsBulkUpdateObject","type":"Interface","label":"SavedObjectsBulkUpdateObject","signature":[{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SavedObjectsBulkUpdateObject","text":"SavedObjectsBulkUpdateObject"},""],"description":[],"children":[{"id":"def-public.SavedObjectsBulkUpdateObject.type","type":"string","label":"type","description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L67"}},{"id":"def-public.SavedObjectsBulkUpdateObject.id","type":"string","label":"id","description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L68"}},{"id":"def-public.SavedObjectsBulkUpdateObject.attributes","type":"Uncategorized","label":"attributes","description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L69"},"signature":["T"]},{"id":"def-public.SavedObjectsBulkUpdateObject.version","type":"string","label":"version","description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L70"},"signature":["string | undefined"]},{"id":"def-public.SavedObjectsBulkUpdateObject.references","type":"Array","label":"references","description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L71"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[] | undefined"]}],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L66"},"initialIsOpen":false},{"id":"def-public.SavedObjectsBulkUpdateOptions","type":"Interface","label":"SavedObjectsBulkUpdateOptions","description":[],"children":[{"id":"def-public.SavedObjectsBulkUpdateOptions.namespace","type":"string","label":"namespace","description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":76,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L76"},"signature":["string | undefined"]}],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L75"},"initialIsOpen":false},{"id":"def-public.SavedObjectsCreateOptions","type":"Interface","label":"SavedObjectsCreateOptions","description":[],"children":[{"id":"def-public.SavedObjectsCreateOptions.id","type":"string","label":"id","description":["\n(Not recommended) Specify an id instead of having the saved objects service generate one for you."],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L38"},"signature":["string | undefined"]},{"id":"def-public.SavedObjectsCreateOptions.overwrite","type":"CompoundType","label":"overwrite","description":["If a document with the given `id` already exists, overwrite it's contents (default=false)."],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L40"},"signature":["boolean | undefined"]},{"id":"def-public.SavedObjectsCreateOptions.migrationVersion","type":"Object","label":"migrationVersion","description":["{@inheritDoc SavedObjectsMigrationVersion}"],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L42"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectsMigrationVersion","text":"SavedObjectsMigrationVersion"}," | undefined"]},{"id":"def-public.SavedObjectsCreateOptions.coreMigrationVersion","type":"string","label":"coreMigrationVersion","description":["A semver value that is used when upgrading objects between Kibana versions."],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L44"},"signature":["string | undefined"]},{"id":"def-public.SavedObjectsCreateOptions.references","type":"Array","label":"references","description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L45"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[] | undefined"]}],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L34"},"initialIsOpen":false},{"id":"def-public.SavedObjectsFindResponsePublic","type":"Interface","label":"SavedObjectsFindResponsePublic","signature":[{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SavedObjectsFindResponsePublic","text":"SavedObjectsFindResponsePublic"}," extends ",{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SavedObjectsBatchResponse","text":"SavedObjectsBatchResponse"},""],"description":["\nReturn type of the Saved Objects `find()` method.\n\n*Note*: this type is different between the Public and Server Saved Objects\nclients.\n"],"children":[{"id":"def-public.SavedObjectsFindResponsePublic.total","type":"number","label":"total","description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":107,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L107"}},{"id":"def-public.SavedObjectsFindResponsePublic.perPage","type":"number","label":"perPage","description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L108"}},{"id":"def-public.SavedObjectsFindResponsePublic.page","type":"number","label":"page","description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":109,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L109"}}],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":106,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L106"},"initialIsOpen":false},{"id":"def-public.SavedObjectsUpdateOptions","type":"Interface","label":"SavedObjectsUpdateOptions","description":[],"children":[{"id":"def-public.SavedObjectsUpdateOptions.version","type":"string","label":"version","description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L81"},"signature":["string | undefined"]},{"id":"def-public.SavedObjectsUpdateOptions.migrationVersion","type":"Object","label":"migrationVersion","description":["{@inheritDoc SavedObjectsMigrationVersion}"],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L83"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectsMigrationVersion","text":"SavedObjectsMigrationVersion"}," | undefined"]},{"id":"def-public.SavedObjectsUpdateOptions.references","type":"Array","label":"references","description":[],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L84"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[] | undefined"]}],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L80"},"initialIsOpen":false},{"id":"def-public.SavedObjectsStart","type":"Interface","label":"SavedObjectsStart","description":[],"children":[{"id":"def-public.SavedObjectsStart.client","type":"Object","label":"client","description":["{@link SavedObjectsClient}"],"source":{"path":"src/core/public/saved_objects/saved_objects_service.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_service.ts#L18"},"signature":["Pick<",{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\">"]}],"source":{"path":"src/core/public/saved_objects/saved_objects_service.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_service.ts#L16"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-public.SavedObjectsClientContract","type":"Type","label":"SavedObjectsClientContract","description":["\nSavedObjectsClientContract as implemented by the {@link SavedObjectsClient}\n"],"source":{"path":"src/core/public/saved_objects/saved_objects_client.ts","lineNumber":138,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/public/saved_objects/saved_objects_client.ts#L138"},"signature":["{ get: (type: string, id: string) => Promise>; delete: (type: string, id: string, options?: SavedObjectsDeleteOptions | undefined) => Promise<{}>; create: (type: string, attributes: T, options?: SavedObjectsCreateOptions) => Promise>; find: (options: Pick) => Promise>; update: (type: string, id: string, attributes: T, { version, migrationVersion, references }?: SavedObjectsUpdateOptions) => Promise>; bulkCreate: (objects?: SavedObjectsBulkCreateObject[], options?: SavedObjectsBulkCreateOptions) => Promise>; bulkGet: (objects?: { id: string; type: string; }[]) => Promise>; bulkUpdate: (objects?: SavedObjectsBulkUpdateObject[]) => Promise>; }"],"initialIsOpen":false}],"objects":[]},"server":{"classes":[{"id":"def-server.SavedObjectsClient","type":"Class","label":"SavedObjectsClient","description":["\n"],"children":[{"id":"def-server.SavedObjectsClient.errors","type":"Object","label":"errors","description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":397,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L397"},"signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"}]},{"id":"def-server.SavedObjectsClient.errors","type":"Object","label":"errors","description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":398,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L398"},"signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"}]},{"id":"def-server.SavedObjectsClient.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"repository","isRequired":true,"signature":["Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsRepository","text":"SavedObjectsRepository"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"deleteByNamespace\" | \"incrementCounter\">"],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":403,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L403"}}],"tags":["internal"],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":403,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L403"}},{"id":"def-server.SavedObjectsClient.create","type":"Function","label":"create","signature":["(type: string, attributes: T, options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsCreateOptions","text":"SavedObjectsCreateOptions"}," | undefined) => Promise<",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},">"],"description":["\nPersists a SavedObject\n"],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":414,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L414"}},{"type":"Uncategorized","label":"attributes","isRequired":true,"signature":["T"],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":414,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L414"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsCreateOptions","text":"SavedObjectsCreateOptions"}," | undefined"],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":414,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L414"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":414,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L414"}},{"id":"def-server.SavedObjectsClient.bulkCreate","type":"Function","label":"bulkCreate","signature":["(objects: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBulkCreateObject","text":"SavedObjectsBulkCreateObject"},"[], options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsCreateOptions","text":"SavedObjectsCreateOptions"}," | undefined) => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBulkResponse","text":"SavedObjectsBulkResponse"},">"],"description":["\nPersists multiple documents batched together as a single request\n"],"children":[{"type":"Array","label":"objects","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBulkCreateObject","text":"SavedObjectsBulkCreateObject"},"[]"],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":425,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L425"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsCreateOptions","text":"SavedObjectsCreateOptions"}," | undefined"],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":426,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L426"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":424,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L424"}},{"id":"def-server.SavedObjectsClient.checkConflicts","type":"Function","label":"checkConflicts","signature":["(objects?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsCheckConflictsObject","text":"SavedObjectsCheckConflictsObject"},"[], options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"},") => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsCheckConflictsResponse","text":"SavedObjectsCheckConflictsResponse"},">"],"description":["\nCheck what conflicts will result when creating a given array of saved objects. This includes \"unresolvable conflicts\", which are\nmulti-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten.\n"],"children":[{"type":"Array","label":"objects","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsCheckConflictsObject","text":"SavedObjectsCheckConflictsObject"},"[]"],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":439,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L439"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":440,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L440"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":438,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L438"}},{"id":"def-server.SavedObjectsClient.delete","type":"Function","label":"delete","signature":["(type: string, id: string, options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsDeleteOptions","text":"SavedObjectsDeleteOptions"},") => Promise<{}>"],"description":["\nDeletes a SavedObject\n"],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":452,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L452"}},{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":452,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L452"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsDeleteOptions","text":"SavedObjectsDeleteOptions"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":452,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L452"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":452,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L452"}},{"id":"def-server.SavedObjectsClient.find","type":"Function","label":"find","signature":["(options: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsFindOptions","text":"SavedObjectsFindOptions"},") => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsFindResponse","text":"SavedObjectsFindResponse"},">"],"description":["\nFind all SavedObjects matching the search query\n"],"children":[{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsFindOptions","text":"SavedObjectsFindOptions"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":461,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L461"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":461,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L461"}},{"id":"def-server.SavedObjectsClient.bulkGet","type":"Function","label":"bulkGet","signature":["(objects?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBulkGetObject","text":"SavedObjectsBulkGetObject"},"[], options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"},") => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBulkResponse","text":"SavedObjectsBulkResponse"},">"],"description":["\nReturns an array of objects by id\n"],"children":[{"type":"Array","label":"objects","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBulkGetObject","text":"SavedObjectsBulkGetObject"},"[]"],"description":["- an array of ids, or an array of objects containing id, type and optionally fields"],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":477,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L477"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":478,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L478"}}],"tags":["example"],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":476,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L476"}},{"id":"def-server.SavedObjectsClient.get","type":"Function","label":"get","signature":["(type: string, id: string, options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"},") => Promise<",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},">"],"description":["\nRetrieves a single object\n"],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":["- The type of SavedObject to retrieve"],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":491,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L491"}},{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":["- The ID of the SavedObject to retrieve"],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":492,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L492"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":493,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L493"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":490,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L490"}},{"id":"def-server.SavedObjectsClient.resolve","type":"Function","label":"resolve","signature":["(type: string, id: string, options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"},") => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsResolveResponse","text":"SavedObjectsResolveResponse"},">"],"description":["\nResolves a single object, using any legacy URL alias if it exists\n"],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":["- The type of SavedObject to retrieve"],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":506,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L506"}},{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":["- The ID of the SavedObject to retrieve"],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":507,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L507"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":508,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L508"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":505,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L505"}},{"id":"def-server.SavedObjectsClient.update","type":"Function","label":"update","signature":["(type: string, id: string, attributes: Partial, options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsUpdateOptions","text":"SavedObjectsUpdateOptions"},") => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsUpdateResponse","text":"SavedObjectsUpdateResponse"},">"],"description":["\nUpdates an SavedObject\n"],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":521,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L521"}},{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":522,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L522"}},{"type":"Object","label":"attributes","isRequired":true,"signature":["Partial"],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":523,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L523"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsUpdateOptions","text":"SavedObjectsUpdateOptions"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":524,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L524"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":520,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L520"}},{"id":"def-server.SavedObjectsClient.addToNamespaces","type":"Function","label":"addToNamespaces","signature":["(type: string, id: string, namespaces: string[], options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsAddToNamespacesOptions","text":"SavedObjectsAddToNamespacesOptions"},") => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsAddToNamespacesResponse","text":"SavedObjectsAddToNamespacesResponse"},">"],"description":["\nAdds namespaces to a SavedObject\n"],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":538,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L538"}},{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":539,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L539"}},{"type":"Array","label":"namespaces","isRequired":true,"signature":["string[]"],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":540,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L540"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsAddToNamespacesOptions","text":"SavedObjectsAddToNamespacesOptions"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":541,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L541"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":537,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L537"}},{"id":"def-server.SavedObjectsClient.deleteFromNamespaces","type":"Function","label":"deleteFromNamespaces","signature":["(type: string, id: string, namespaces: string[], options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsDeleteFromNamespacesOptions","text":"SavedObjectsDeleteFromNamespacesOptions"},") => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsDeleteFromNamespacesResponse","text":"SavedObjectsDeleteFromNamespacesResponse"},">"],"description":["\nRemoves namespaces from a SavedObject\n"],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":555,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L555"}},{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":556,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L556"}},{"type":"Array","label":"namespaces","isRequired":true,"signature":["string[]"],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":557,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L557"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsDeleteFromNamespacesOptions","text":"SavedObjectsDeleteFromNamespacesOptions"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":558,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L558"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":554,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L554"}},{"id":"def-server.SavedObjectsClient.bulkUpdate","type":"Function","label":"bulkUpdate","signature":["(objects: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBulkUpdateObject","text":"SavedObjectsBulkUpdateObject"},"[], options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBulkUpdateOptions","text":"SavedObjectsBulkUpdateOptions"}," | undefined) => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBulkUpdateResponse","text":"SavedObjectsBulkUpdateResponse"},">"],"description":["\nBulk Updates multiple SavedObject at once\n"],"children":[{"type":"Array","label":"objects","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBulkUpdateObject","text":"SavedObjectsBulkUpdateObject"},"[]"],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":569,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L569"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBulkUpdateOptions","text":"SavedObjectsBulkUpdateOptions"}," | undefined"],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":570,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L570"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":568,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L568"}},{"id":"def-server.SavedObjectsClient.removeReferencesTo","type":"Function","label":"removeReferencesTo","signature":["(type: string, id: string, options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsRemoveReferencesToOptions","text":"SavedObjectsRemoveReferencesToOptions"}," | undefined) => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsRemoveReferencesToResponse","text":"SavedObjectsRemoveReferencesToResponse"},">"],"description":["\nUpdates all objects containing a reference to the given {type, id} tuple to remove the said reference."],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":579,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L579"}},{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":580,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L580"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsRemoveReferencesToOptions","text":"SavedObjectsRemoveReferencesToOptions"}," | undefined"],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":581,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L581"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":578,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L578"}},{"id":"def-server.SavedObjectsClient.openPointInTimeForType","type":"Function","label":"openPointInTimeForType","signature":["(type: string | string[], options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsOpenPointInTimeOptions","text":"SavedObjectsOpenPointInTimeOptions"},") => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsOpenPointInTimeResponse","text":"SavedObjectsOpenPointInTimeResponse"},">"],"description":["\nOpens a Point In Time (PIT) against the indices for the specified Saved Object types.\nThe returned `id` can then be passed to {@link SavedObjectsClient.find} to search\nagainst that PIT."],"children":[{"type":"CompoundType","label":"type","isRequired":true,"signature":["string | string[]"],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":592,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L592"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsOpenPointInTimeOptions","text":"SavedObjectsOpenPointInTimeOptions"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":593,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L593"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":591,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L591"}},{"id":"def-server.SavedObjectsClient.closePointInTime","type":"Function","label":"closePointInTime","signature":["(id: string, options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"}," | undefined) => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClosePointInTimeResponse","text":"SavedObjectsClosePointInTimeResponse"},">"],"description":["\nCloses a Point In Time (PIT) by ID. This simply proxies the request to ES via the\nElasticsearch client, and is included in the Saved Objects Client as a convenience\nfor consumers who are using {@link SavedObjectsClient.openPointInTimeForType}."],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":603,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L603"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"}," | undefined"],"description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":603,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L603"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":603,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L603"}}],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":396,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L396"},"initialIsOpen":false},{"id":"def-server.SavedObjectsErrorHelpers","type":"Class","label":"SavedObjectsErrorHelpers","description":[],"children":[{"id":"def-server.SavedObjectsErrorHelpers.isSavedObjectsClientError","type":"Function","label":"isSavedObjectsClientError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"},".isSavedObjectsClientError"],"description":[],"children":[{"type":"Any","label":"error","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L73"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L73"}},{"id":"def-server.SavedObjectsErrorHelpers.decorateBadRequestError","type":"Function","label":"decorateBadRequestError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"},".decorateBadRequestError"],"description":[],"children":[{"type":"Object","label":"error","isRequired":true,"signature":["Error"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L77"}},{"type":"string","label":"reason","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L77"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L77"}},{"id":"def-server.SavedObjectsErrorHelpers.createBadRequestError","type":"Function","label":"createBadRequestError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"},".createBadRequestError"],"description":[],"children":[{"type":"string","label":"reason","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L81"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L81"}},{"id":"def-server.SavedObjectsErrorHelpers.createUnsupportedTypeError","type":"Function","label":"createUnsupportedTypeError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"},".createUnsupportedTypeError"],"description":[],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":85,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L85"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":85,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L85"}},{"id":"def-server.SavedObjectsErrorHelpers.isBadRequestError","type":"Function","label":"isBadRequestError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"},".isBadRequestError"],"description":[],"children":[{"type":"CompoundType","label":"error","isRequired":true,"signature":["Error | ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.DecoratedError","text":"DecoratedError"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L92"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L92"}},{"id":"def-server.SavedObjectsErrorHelpers.createInvalidVersionError","type":"Function","label":"createInvalidVersionError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"},".createInvalidVersionError"],"description":[],"children":[{"type":"string","label":"versionInput","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L96"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L96"}},{"id":"def-server.SavedObjectsErrorHelpers.isInvalidVersionError","type":"Function","label":"isInvalidVersionError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"},".isInvalidVersionError"],"description":[],"children":[{"type":"CompoundType","label":"error","isRequired":true,"signature":["Error | ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.DecoratedError","text":"DecoratedError"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L104"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L104"}},{"id":"def-server.SavedObjectsErrorHelpers.decorateNotAuthorizedError","type":"Function","label":"decorateNotAuthorizedError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"},".decorateNotAuthorizedError"],"description":[],"children":[{"type":"Object","label":"error","isRequired":true,"signature":["Error"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L108"}},{"type":"string","label":"reason","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L108"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L108"}},{"id":"def-server.SavedObjectsErrorHelpers.isNotAuthorizedError","type":"Function","label":"isNotAuthorizedError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"},".isNotAuthorizedError"],"description":[],"children":[{"type":"CompoundType","label":"error","isRequired":true,"signature":["Error | ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.DecoratedError","text":"DecoratedError"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":112,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L112"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":112,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L112"}},{"id":"def-server.SavedObjectsErrorHelpers.decorateForbiddenError","type":"Function","label":"decorateForbiddenError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"},".decorateForbiddenError"],"description":[],"children":[{"type":"Object","label":"error","isRequired":true,"signature":["Error"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L116"}},{"type":"string","label":"reason","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L116"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L116"}},{"id":"def-server.SavedObjectsErrorHelpers.isForbiddenError","type":"Function","label":"isForbiddenError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"},".isForbiddenError"],"description":[],"children":[{"type":"CompoundType","label":"error","isRequired":true,"signature":["Error | ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.DecoratedError","text":"DecoratedError"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":120,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L120"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":120,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L120"}},{"id":"def-server.SavedObjectsErrorHelpers.decorateRequestEntityTooLargeError","type":"Function","label":"decorateRequestEntityTooLargeError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"},".decorateRequestEntityTooLargeError"],"description":[],"children":[{"type":"Object","label":"error","isRequired":true,"signature":["Error"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":124,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L124"}},{"type":"string","label":"reason","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":124,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L124"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":124,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L124"}},{"id":"def-server.SavedObjectsErrorHelpers.isRequestEntityTooLargeError","type":"Function","label":"isRequestEntityTooLargeError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"},".isRequestEntityTooLargeError"],"description":[],"children":[{"type":"CompoundType","label":"error","isRequired":true,"signature":["Error | ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.DecoratedError","text":"DecoratedError"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":127,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L127"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":127,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L127"}},{"id":"def-server.SavedObjectsErrorHelpers.createGenericNotFoundError","type":"Function","label":"createGenericNotFoundError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"},".createGenericNotFoundError"],"description":[],"children":[{"type":"CompoundType","label":"type","isRequired":false,"signature":["string | null"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L131"}},{"type":"CompoundType","label":"id","isRequired":false,"signature":["string | null"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L131"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L131"}},{"id":"def-server.SavedObjectsErrorHelpers.createIndexAliasNotFoundError","type":"Function","label":"createIndexAliasNotFoundError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"},".createIndexAliasNotFoundError"],"description":[],"children":[{"type":"string","label":"alias","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":138,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L138"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":138,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L138"}},{"id":"def-server.SavedObjectsErrorHelpers.decorateIndexAliasNotFoundError","type":"Function","label":"decorateIndexAliasNotFoundError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"},".decorateIndexAliasNotFoundError"],"description":[],"children":[{"type":"Object","label":"error","isRequired":true,"signature":["Error"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":142,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L142"}},{"type":"string","label":"alias","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":142,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L142"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":142,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L142"}},{"id":"def-server.SavedObjectsErrorHelpers.isNotFoundError","type":"Function","label":"isNotFoundError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"},".isNotFoundError"],"description":[],"children":[{"type":"CompoundType","label":"error","isRequired":true,"signature":["Error | ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.DecoratedError","text":"DecoratedError"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":151,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L151"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":151,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L151"}},{"id":"def-server.SavedObjectsErrorHelpers.decorateConflictError","type":"Function","label":"decorateConflictError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"},".decorateConflictError"],"description":[],"children":[{"type":"Object","label":"error","isRequired":true,"signature":["Error"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":155,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L155"}},{"type":"string","label":"reason","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":155,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L155"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":155,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L155"}},{"id":"def-server.SavedObjectsErrorHelpers.createConflictError","type":"Function","label":"createConflictError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"},".createConflictError"],"description":[],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":159,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L159"}},{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":159,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L159"}},{"type":"string","label":"reason","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":159,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L159"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":159,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L159"}},{"id":"def-server.SavedObjectsErrorHelpers.isConflictError","type":"Function","label":"isConflictError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"},".isConflictError"],"description":[],"children":[{"type":"CompoundType","label":"error","isRequired":true,"signature":["Error | ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.DecoratedError","text":"DecoratedError"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":166,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L166"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":166,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L166"}},{"id":"def-server.SavedObjectsErrorHelpers.decorateTooManyRequestsError","type":"Function","label":"decorateTooManyRequestsError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"},".decorateTooManyRequestsError"],"description":[],"children":[{"type":"Object","label":"error","isRequired":true,"signature":["Error"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":170,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L170"}},{"type":"string","label":"reason","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":170,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L170"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":170,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L170"}},{"id":"def-server.SavedObjectsErrorHelpers.createTooManyRequestsError","type":"Function","label":"createTooManyRequestsError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"},".createTooManyRequestsError"],"description":[],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":174,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L174"}},{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":174,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L174"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":174,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L174"}},{"id":"def-server.SavedObjectsErrorHelpers.isTooManyRequestsError","type":"Function","label":"isTooManyRequestsError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"},".isTooManyRequestsError"],"description":[],"children":[{"type":"CompoundType","label":"error","isRequired":true,"signature":["Error | ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.DecoratedError","text":"DecoratedError"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":178,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L178"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":178,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L178"}},{"id":"def-server.SavedObjectsErrorHelpers.decorateEsCannotExecuteScriptError","type":"Function","label":"decorateEsCannotExecuteScriptError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"},".decorateEsCannotExecuteScriptError"],"description":[],"children":[{"type":"Object","label":"error","isRequired":true,"signature":["Error"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":182,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L182"}},{"type":"string","label":"reason","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":182,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L182"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":182,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L182"}},{"id":"def-server.SavedObjectsErrorHelpers.isEsCannotExecuteScriptError","type":"Function","label":"isEsCannotExecuteScriptError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"},".isEsCannotExecuteScriptError"],"description":[],"children":[{"type":"CompoundType","label":"error","isRequired":true,"signature":["Error | ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.DecoratedError","text":"DecoratedError"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":186,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L186"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":186,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L186"}},{"id":"def-server.SavedObjectsErrorHelpers.decorateEsUnavailableError","type":"Function","label":"decorateEsUnavailableError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"},".decorateEsUnavailableError"],"description":[],"children":[{"type":"Object","label":"error","isRequired":true,"signature":["Error"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":190,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L190"}},{"type":"string","label":"reason","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":190,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L190"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":190,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L190"}},{"id":"def-server.SavedObjectsErrorHelpers.isEsUnavailableError","type":"Function","label":"isEsUnavailableError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"},".isEsUnavailableError"],"description":[],"children":[{"type":"CompoundType","label":"error","isRequired":true,"signature":["Error | ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.DecoratedError","text":"DecoratedError"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":194,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L194"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":194,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L194"}},{"id":"def-server.SavedObjectsErrorHelpers.decorateGeneralError","type":"Function","label":"decorateGeneralError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"},".decorateGeneralError"],"description":[],"children":[{"type":"Object","label":"error","isRequired":true,"signature":["Error"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":198,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L198"}},{"type":"string","label":"reason","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":198,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L198"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":198,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L198"}},{"id":"def-server.SavedObjectsErrorHelpers.isGeneralError","type":"Function","label":"isGeneralError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsErrorHelpers","text":"SavedObjectsErrorHelpers"},".isGeneralError"],"description":[],"children":[{"type":"CompoundType","label":"error","isRequired":true,"signature":["Error | ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.DecoratedError","text":"DecoratedError"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":202,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L202"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":202,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L202"}}],"source":{"path":"src/core/server/saved_objects/service/lib/errors.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/errors.ts#L72"},"initialIsOpen":false},{"id":"def-server.SavedObjectsSerializer","type":"Class","label":"SavedObjectsSerializer","description":["\nA serializer that can be used to manually convert {@link SavedObjectsRawDoc | raw} or\n{@link SavedObjectSanitizedDoc | sanitized} documents to the other kind.\n"],"children":[{"id":"def-server.SavedObjectsSerializer.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"registry","isRequired":true,"signature":["Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectTypeRegistry","text":"SavedObjectTypeRegistry"},", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">"],"description":[],"source":{"path":"src/core/server/saved_objects/serialization/serializer.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L32"}}],"tags":["internal"],"returnComment":[],"source":{"path":"src/core/server/saved_objects/serialization/serializer.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L32"}},{"id":"def-server.SavedObjectsSerializer.isRawSavedObject","type":"Function","label":"isRawSavedObject","signature":["(doc: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsRawDoc","text":"SavedObjectsRawDoc"},", options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsRawDocParseOptions","text":"SavedObjectsRawDocParseOptions"},") => boolean"],"description":["\nDetermines whether or not the raw document can be converted to a saved object.\n"],"children":[{"type":"Object","label":"doc","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsRawDoc","text":"SavedObjectsRawDoc"}],"description":["- The raw ES document to be tested"],"source":{"path":"src/core/server/saved_objects/serialization/serializer.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L41"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsRawDocParseOptions","text":"SavedObjectsRawDocParseOptions"}],"description":["- Options for parsing the raw document."],"source":{"path":"src/core/server/saved_objects/serialization/serializer.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L41"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/serialization/serializer.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L41"}},{"id":"def-server.SavedObjectsSerializer.rawToSavedObject","type":"Function","label":"rawToSavedObject","signature":["(doc: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsRawDoc","text":"SavedObjectsRawDoc"},", options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsRawDocParseOptions","text":"SavedObjectsRawDocParseOptions"},") => ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectSanitizedDoc","text":"SavedObjectSanitizedDoc"},""],"description":["\nConverts a document from the format that is stored in elasticsearch to the saved object client format.\n"],"children":[{"type":"Object","label":"doc","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsRawDoc","text":"SavedObjectsRawDoc"}],"description":["- The raw ES document to be converted to saved object format."],"source":{"path":"src/core/server/saved_objects/serialization/serializer.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L59"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsRawDocParseOptions","text":"SavedObjectsRawDocParseOptions"}],"description":["- Options for parsing the raw document."],"source":{"path":"src/core/server/saved_objects/serialization/serializer.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L60"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/serialization/serializer.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L58"}},{"id":"def-server.SavedObjectsSerializer.savedObjectToRaw","type":"Function","label":"savedObjectToRaw","signature":["(savedObj: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectSanitizedDoc","text":"SavedObjectSanitizedDoc"},") => ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsRawDoc","text":"SavedObjectsRawDoc"}],"description":["\nConverts a document from the saved object client format to the format that is stored in elasticsearch.\n"],"children":[{"type":"CompoundType","label":"savedObj","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectSanitizedDoc","text":"SavedObjectSanitizedDoc"},""],"description":["- The saved object to be converted to raw ES format."],"source":{"path":"src/core/server/saved_objects/serialization/serializer.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L102"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/serialization/serializer.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L102"}},{"id":"def-server.SavedObjectsSerializer.generateRawId","type":"Function","label":"generateRawId","signature":["(namespace: string | undefined, type: string, id: string) => string"],"description":["\nGiven a saved object type and id, generates the compound id that is stored in the raw document.\n"],"children":[{"type":"string","label":"namespace","isRequired":false,"signature":["string | undefined"],"description":["- The namespace of the saved object"],"source":{"path":"src/core/server/saved_objects/serialization/serializer.ts","lineNumber":143,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L143"}},{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":["- The saved object type"],"source":{"path":"src/core/server/saved_objects/serialization/serializer.ts","lineNumber":143,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L143"}},{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":["- The id of the saved object"],"source":{"path":"src/core/server/saved_objects/serialization/serializer.ts","lineNumber":143,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L143"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/serialization/serializer.ts","lineNumber":143,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L143"}},{"id":"def-server.SavedObjectsSerializer.generateRawLegacyUrlAliasId","type":"Function","label":"generateRawLegacyUrlAliasId","signature":["(namespace: string, type: string, id: string) => string"],"description":["\nGiven a saved object type and id, generates the compound id that is stored in the raw document for its legacy URL alias.\n"],"children":[{"type":"string","label":"namespace","isRequired":true,"signature":["string"],"description":["- The namespace of the saved object"],"source":{"path":"src/core/server/saved_objects/serialization/serializer.ts","lineNumber":156,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L156"}},{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":["- The saved object type"],"source":{"path":"src/core/server/saved_objects/serialization/serializer.ts","lineNumber":156,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L156"}},{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":["- The id of the saved object"],"source":{"path":"src/core/server/saved_objects/serialization/serializer.ts","lineNumber":156,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L156"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/serialization/serializer.ts","lineNumber":156,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L156"}}],"source":{"path":"src/core/server/saved_objects/serialization/serializer.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/serializer.ts#L26"},"initialIsOpen":false},{"id":"def-server.SavedObjectsRepository","type":"Class","label":"SavedObjectsRepository","description":[],"children":[{"id":"def-server.SavedObjectsRepository.createRepository","type":"Function","label":"createRepository","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsRepository","text":"SavedObjectsRepository"},".createRepository"],"description":["\nA factory function for creating SavedObjectRepository instances.\n"],"children":[{"type":"Object","label":"migrator","isRequired":true,"signature":["Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.KibanaMigrator","text":"KibanaMigrator"},", \"kibanaVersion\" | \"savedObjectsConfig\" | \"runMigrations\" | \"prepareMigrations\" | \"getStatus$\" | \"getActiveMappings\" | \"migrateDocument\">"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":161,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L161"}},{"type":"Object","label":"typeRegistry","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectTypeRegistry","text":"SavedObjectTypeRegistry"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":162,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L162"}},{"type":"string","label":"indexName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":163,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L163"}},{"type":"CompoundType","label":"client","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ElasticsearchClient","text":"ElasticsearchClient"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":164,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L164"}},{"type":"Array","label":"includedHiddenTypes","isRequired":true,"signature":["string[]"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":165,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L165"}},{"type":"Any","label":"injectedConstructor","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":166,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L166"}}],"tags":["internalRemarks","internal"],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":160,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L160"}},{"id":"def-server.SavedObjectsRepository.create","type":"Function","label":"create","signature":["(type: string, attributes: T, options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsCreateOptions","text":"SavedObjectsCreateOptions"},") => Promise<",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},">"],"description":["\nPersists an object\n"],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":237,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L237"}},{"type":"Uncategorized","label":"attributes","isRequired":true,"signature":["T"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":238,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L238"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsCreateOptions","text":"SavedObjectsCreateOptions"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":239,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L239"}}],"tags":["property","property","property","property","property"],"returnComment":["- { id, type, version, attributes }"],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":236,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L236"}},{"id":"def-server.SavedObjectsRepository.bulkCreate","type":"Function","label":"bulkCreate","signature":["(objects: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBulkCreateObject","text":"SavedObjectsBulkCreateObject"},"[], options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsCreateOptions","text":"SavedObjectsCreateOptions"},") => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBulkResponse","text":"SavedObjectsBulkResponse"},">"],"description":["\nCreates multiple documents at once\n"],"children":[{"type":"Array","label":"objects","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBulkCreateObject","text":"SavedObjectsBulkCreateObject"},"[]"],"description":["- [{ type, id, attributes, references, migrationVersion }]"],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":330,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L330"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsCreateOptions","text":"SavedObjectsCreateOptions"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":331,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L331"}}],"tags":["property","property"],"returnComment":["- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]}"],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":329,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L329"}},{"id":"def-server.SavedObjectsRepository.checkConflicts","type":"Function","label":"checkConflicts","signature":["(objects?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsCheckConflictsObject","text":"SavedObjectsCheckConflictsObject"},"[], options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"},") => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsCheckConflictsResponse","text":"SavedObjectsCheckConflictsResponse"},">"],"description":["\nCheck what conflicts will result when creating a given array of saved objects. This includes \"unresolvable conflicts\", which are\nmulti-namespace objects that exist in a different namespace; such conflicts cannot be resolved/overwritten."],"children":[{"type":"Array","label":"objects","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsCheckConflictsObject","text":"SavedObjectsCheckConflictsObject"},"[]"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":517,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L517"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":518,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L518"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":516,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L516"}},{"id":"def-server.SavedObjectsRepository.delete","type":"Function","label":"delete","signature":["(type: string, id: string, options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsDeleteOptions","text":"SavedObjectsDeleteOptions"},") => Promise<{}>"],"description":["\nDeletes an object\n"],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":602,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L602"}},{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":602,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L602"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsDeleteOptions","text":"SavedObjectsDeleteOptions"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":602,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L602"}}],"tags":["property"],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":602,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L602"}},{"id":"def-server.SavedObjectsRepository.deleteByNamespace","type":"Function","label":"deleteByNamespace","signature":["(namespace: string, options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsDeleteByNamespaceOptions","text":"SavedObjectsDeleteByNamespaceOptions"},") => Promise"],"description":["\nDeletes all objects from the provided namespace.\n"],"children":[{"type":"string","label":"namespace","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":664,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L664"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsDeleteByNamespaceOptions","text":"SavedObjectsDeleteByNamespaceOptions"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":665,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L665"}}],"tags":[],"returnComment":["- { took, timed_out, total, deleted, batches, version_conflicts, noops, retries, failures }"],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":663,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L663"}},{"id":"def-server.SavedObjectsRepository.find","type":"Function","label":"find","signature":["(options: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsFindOptions","text":"SavedObjectsFindOptions"},") => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsFindResponse","text":"SavedObjectsFindResponse"},">"],"description":[],"children":[{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsFindOptions","text":"SavedObjectsFindOptions"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":725,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L725"}}],"tags":["property","property","property","property","property","property","property","property","property","property","property","property","property","property"],"returnComment":["- { saved_objects: [{ id, type, version, attributes }], total, per_page, page }"],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":725,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L725"}},{"id":"def-server.SavedObjectsRepository.bulkGet","type":"Function","label":"bulkGet","signature":["(objects?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBulkGetObject","text":"SavedObjectsBulkGetObject"},"[], options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"},") => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBulkResponse","text":"SavedObjectsBulkResponse"},">"],"description":["\nReturns an array of objects by id\n"],"children":[{"type":"Array","label":"objects","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBulkGetObject","text":"SavedObjectsBulkGetObject"},"[]"],"description":["- an array of objects containing id, type and optionally fields"],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":875,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L875"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":876,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L876"}}],"tags":["property","example"],"returnComment":["- { saved_objects: [{ id, type, version, attributes }] }"],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":874,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L874"}},{"id":"def-server.SavedObjectsRepository.get","type":"Function","label":"get","signature":["(type: string, id: string, options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"},") => Promise<",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},">"],"description":["\nGets a single object\n"],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":960,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L960"}},{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":961,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L961"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":962,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L962"}}],"tags":["property"],"returnComment":["- { id, type, version, attributes }"],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":959,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L959"}},{"id":"def-server.SavedObjectsRepository.resolve","type":"Function","label":"resolve","signature":["(type: string, id: string, options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"},") => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsResolveResponse","text":"SavedObjectsResolveResponse"},">"],"description":["\nResolves a single object, using any legacy URL alias if it exists\n"],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":998,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L998"}},{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":999,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L999"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1000,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1000"}}],"tags":["property"],"returnComment":["- { saved_object, outcome }"],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":997,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L997"}},{"id":"def-server.SavedObjectsRepository.update","type":"Function","label":"update","signature":["(type: string, id: string, attributes: Partial, options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsUpdateOptions","text":"SavedObjectsUpdateOptions"},") => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsUpdateResponse","text":"SavedObjectsUpdateResponse"},">"],"description":["\nUpdates an object\n"],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1117,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1117"}},{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1118,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1118"}},{"type":"Object","label":"attributes","isRequired":true,"signature":["Partial"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1119,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1119"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsUpdateOptions","text":"SavedObjectsUpdateOptions"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1120,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1120"}}],"tags":["property","property","property"],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1116,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1116"}},{"id":"def-server.SavedObjectsRepository.addToNamespaces","type":"Function","label":"addToNamespaces","signature":["(type: string, id: string, namespaces: string[], options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsAddToNamespacesOptions","text":"SavedObjectsAddToNamespacesOptions"},") => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsAddToNamespacesResponse","text":"SavedObjectsAddToNamespacesResponse"},">"],"description":["\nAdds one or more namespaces to a given multi-namespace saved object. This method and\n[`deleteFromNamespaces`]{@link SavedObjectsRepository.deleteFromNamespaces} are the only ways to change which Spaces a multi-namespace\nsaved object is shared to."],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1190,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1190"}},{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1191,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1191"}},{"type":"Array","label":"namespaces","isRequired":true,"signature":["string[]"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1192,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1192"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsAddToNamespacesOptions","text":"SavedObjectsAddToNamespacesOptions"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1193,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1193"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1189,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1189"}},{"id":"def-server.SavedObjectsRepository.deleteFromNamespaces","type":"Function","label":"deleteFromNamespaces","signature":["(type: string, id: string, namespaces: string[], options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsDeleteFromNamespacesOptions","text":"SavedObjectsDeleteFromNamespacesOptions"},") => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsDeleteFromNamespacesResponse","text":"SavedObjectsDeleteFromNamespacesResponse"},">"],"description":["\nRemoves one or more namespaces from a given multi-namespace saved object. If no namespaces remain, the saved object is deleted\nentirely. This method and [`addToNamespaces`]{@link SavedObjectsRepository.addToNamespaces} are the only ways to change which Spaces a\nmulti-namespace saved object is shared to."],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1253,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1253"}},{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1254,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1254"}},{"type":"Array","label":"namespaces","isRequired":true,"signature":["string[]"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1255,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1255"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsDeleteFromNamespacesOptions","text":"SavedObjectsDeleteFromNamespacesOptions"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1256,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1256"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1252,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1252"}},{"id":"def-server.SavedObjectsRepository.bulkUpdate","type":"Function","label":"bulkUpdate","signature":["(objects: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBulkUpdateObject","text":"SavedObjectsBulkUpdateObject"},"[], options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBulkUpdateOptions","text":"SavedObjectsBulkUpdateOptions"},") => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBulkUpdateResponse","text":"SavedObjectsBulkUpdateResponse"},">"],"description":["\nUpdates multiple objects in bulk\n"],"children":[{"type":"Array","label":"objects","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBulkUpdateObject","text":"SavedObjectsBulkUpdateObject"},"[]"],"description":["- [{ type, id, attributes, options: { version, namespace } references }]"],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1358,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1358"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBulkUpdateOptions","text":"SavedObjectsBulkUpdateOptions"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1359,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1359"}}],"tags":["property","property"],"returnComment":["- {saved_objects: [[{ id, type, version, references, attributes, error: { message } }]}"],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1357,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1357"}},{"id":"def-server.SavedObjectsRepository.removeReferencesTo","type":"Function","label":"removeReferencesTo","signature":["(type: string, id: string, options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsRemoveReferencesToOptions","text":"SavedObjectsRemoveReferencesToOptions"},") => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsRemoveReferencesToResponse","text":"SavedObjectsRemoveReferencesToResponse"},">"],"description":["\nUpdates all objects containing a reference to the given {type, id} tuple to remove the said reference.\n"],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1573,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1573"}},{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1574,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1574"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsRemoveReferencesToOptions","text":"SavedObjectsRemoveReferencesToOptions"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1575,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1575"}}],"tags":["remarks"],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1572,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1572"}},{"id":"def-server.SavedObjectsRepository.incrementCounter","type":"Function","label":"incrementCounter","signature":["(type: string, id: string, counterFields: (string | ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsIncrementCounterField","text":"SavedObjectsIncrementCounterField"},")[], options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsIncrementCounterOptions","text":"SavedObjectsIncrementCounterOptions"},") => Promise<",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},">"],"description":["\nIncrements all the specified counter fields (by one by default). Creates the document\nif one doesn't exist for the given id.\n"],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":["- The type of saved object whose fields should be incremented"],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1670,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1670"}},{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":["- The id of the document whose fields should be incremented"],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1671,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1671"}},{"type":"Array","label":"counterFields","isRequired":true,"signature":["(string | ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsIncrementCounterField","text":"SavedObjectsIncrementCounterField"},")[]"],"description":["- An array of field names to increment or an array of {@link SavedObjectsIncrementCounterField}"],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1672,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1672"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsIncrementCounterOptions","text":"SavedObjectsIncrementCounterOptions"}],"description":["- {@link SavedObjectsIncrementCounterOptions}"],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1673,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1673"}}],"tags":["remarks","example"],"returnComment":["The saved object after the specified fields were incremented"],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1669,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1669"}},{"id":"def-server.SavedObjectsRepository.openPointInTimeForType","type":"Function","label":"openPointInTimeForType","signature":["(type: string | string[], { keepAlive, preference }?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsOpenPointInTimeOptions","text":"SavedObjectsOpenPointInTimeOptions"},") => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsOpenPointInTimeResponse","text":"SavedObjectsOpenPointInTimeResponse"},">"],"description":["\nOpens a Point In Time (PIT) against the indices for the specified Saved Object types.\nThe returned `id` can then be passed to `SavedObjects.find` to search against that PIT.\n"],"children":[{"type":"CompoundType","label":"type","isRequired":true,"signature":["string | string[]"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1821,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1821"}},{"type":"Object","label":"{ keepAlive = '5m', preference }","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsOpenPointInTimeOptions","text":"SavedObjectsOpenPointInTimeOptions"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1822,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1822"}}],"tags":["example","property","property"],"returnComment":["- { id: string }"],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1820,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1820"}},{"id":"def-server.SavedObjectsRepository.closePointInTime","type":"Function","label":"closePointInTime","signature":["(id: string, options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"}," | undefined) => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClosePointInTimeResponse","text":"SavedObjectsClosePointInTimeResponse"},">"],"description":["\nCloses a Point In Time (PIT) by ID. This simply proxies the request to ES\nvia the Elasticsearch client, and is included in the Saved Objects Client\nas a convenience for consumers who are using `openPointInTimeForType`.\n"],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1890,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1890"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"}," | undefined"],"description":["- {@link SavedObjectsClosePointInTimeOptions}"],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1891,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1891"}}],"tags":["remarks","example"],"returnComment":["- {@link SavedObjectsClosePointInTimeResponse}"],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":1889,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L1889"}}],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":143,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L143"},"initialIsOpen":false},{"id":"def-server.SavedObjectTypeRegistry","type":"Class","label":"SavedObjectTypeRegistry","description":["\nRegistry holding information about all the registered {@link SavedObjectsType | saved object types}.\n"],"children":[{"id":"def-server.SavedObjectTypeRegistry.registerType","type":"Function","label":"registerType","signature":["(type: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsType","text":"SavedObjectsType"},") => void"],"description":["\nRegister a {@link SavedObjectsType | type} inside the registry.\nA type can only be registered once. subsequent calls with the same type name will throw an error."],"children":[{"type":"Object","label":"type","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsType","text":"SavedObjectsType"}],"description":[],"source":{"path":"src/core/server/saved_objects/saved_objects_type_registry.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L31"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/saved_objects_type_registry.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L31"}},{"id":"def-server.SavedObjectTypeRegistry.getType","type":"Function","label":"getType","signature":["(type: string) => ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsType","text":"SavedObjectsType"}," | undefined"],"description":["\nReturn the {@link SavedObjectsType | type} definition for given type name."],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/saved_objects_type_registry.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L42"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/saved_objects_type_registry.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L42"}},{"id":"def-server.SavedObjectTypeRegistry.getVisibleTypes","type":"Function","label":"getVisibleTypes","signature":["() => ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsType","text":"SavedObjectsType"},"[]"],"description":["\nReturns all visible {@link SavedObjectsType | types}.\n\nA visible type is a type that doesn't explicitly define `hidden=true` during registration."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/saved_objects_type_registry.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L51"}},{"id":"def-server.SavedObjectTypeRegistry.getAllTypes","type":"Function","label":"getAllTypes","signature":["() => ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsType","text":"SavedObjectsType"},"[]"],"description":["\nReturn all {@link SavedObjectsType | types} currently registered, including the hidden ones.\n\nTo only get the visible types (which is the most common use case), use `getVisibleTypes` instead."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/saved_objects_type_registry.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L60"}},{"id":"def-server.SavedObjectTypeRegistry.getImportableAndExportableTypes","type":"Function","label":"getImportableAndExportableTypes","signature":["() => ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsType","text":"SavedObjectsType"},"[]"],"description":["\nReturn all {@link SavedObjectsType | types} currently registered that are importable/exportable."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/saved_objects_type_registry.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L67"}},{"id":"def-server.SavedObjectTypeRegistry.isNamespaceAgnostic","type":"Function","label":"isNamespaceAgnostic","signature":["(type: string) => boolean"],"description":["\nReturns whether the type is namespace-agnostic (global);\nresolves to `false` if the type is not registered"],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/saved_objects_type_registry.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L75"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/saved_objects_type_registry.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L75"}},{"id":"def-server.SavedObjectTypeRegistry.isSingleNamespace","type":"Function","label":"isSingleNamespace","signature":["(type: string) => boolean"],"description":["\nReturns whether the type is single-namespace (isolated);\nresolves to `true` if the type is not registered"],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/saved_objects_type_registry.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L83"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/saved_objects_type_registry.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L83"}},{"id":"def-server.SavedObjectTypeRegistry.isMultiNamespace","type":"Function","label":"isMultiNamespace","signature":["(type: string) => boolean"],"description":["\nReturns whether the type is multi-namespace (shareable *or* isolated);\nresolves to `false` if the type is not registered"],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/saved_objects_type_registry.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L92"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/saved_objects_type_registry.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L92"}},{"id":"def-server.SavedObjectTypeRegistry.isShareable","type":"Function","label":"isShareable","signature":["(type: string) => boolean"],"description":["\nReturns whether the type is multi-namespace (shareable);\nresolves to `false` if the type is not registered"],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/saved_objects_type_registry.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L101"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/saved_objects_type_registry.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L101"}},{"id":"def-server.SavedObjectTypeRegistry.isHidden","type":"Function","label":"isHidden","signature":["(type: string) => boolean"],"description":["\nReturns the `hidden` property for given type, or `false` if\nthe type is not registered."],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/saved_objects_type_registry.ts","lineNumber":109,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L109"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/saved_objects_type_registry.ts","lineNumber":109,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L109"}},{"id":"def-server.SavedObjectTypeRegistry.getIndex","type":"Function","label":"getIndex","signature":["(type: string) => string | undefined"],"description":["\nReturns the `indexPattern` property for given type, or `undefined` if\nthe type is not registered."],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/saved_objects_type_registry.ts","lineNumber":117,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L117"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/saved_objects_type_registry.ts","lineNumber":117,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L117"}},{"id":"def-server.SavedObjectTypeRegistry.isImportableAndExportable","type":"Function","label":"isImportableAndExportable","signature":["(type: string) => boolean"],"description":["\nReturns the `management.importableAndExportable` property for given type, or\n`false` if the type is not registered or does not define a management section."],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/saved_objects_type_registry.ts","lineNumber":125,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L125"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/saved_objects_type_registry.ts","lineNumber":125,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L125"}}],"source":{"path":"src/core/server/saved_objects/saved_objects_type_registry.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L24"},"initialIsOpen":false},{"id":"def-server.SavedObjectsUtils","type":"Class","label":"SavedObjectsUtils","description":[],"children":[{"id":"def-server.SavedObjectsUtils.namespaceIdToString","type":"Function","children":[{"type":"string","label":"namespace","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/utils.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L29"}}],"signature":["(namespace?: string | undefined) => string"],"description":["\nConverts a given saved object namespace ID to its string representation. All namespace IDs have an identical string representation, with\nthe exception of the `undefined` namespace ID (which has a namespace string of `'default'`).\n"],"label":"namespaceIdToString","source":{"path":"src/core/server/saved_objects/service/lib/utils.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L29"},"returnComment":[]},{"id":"def-server.SavedObjectsUtils.namespaceStringToId","type":"Function","children":[{"type":"string","label":"namespace","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/utils.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L43"}}],"signature":["(namespace: string) => string | undefined"],"description":["\nConverts a given saved object namespace string to its ID representation. All namespace strings have an identical ID representation, with\nthe exception of the `'default'` namespace string (which has a namespace ID of `undefined`).\n"],"label":"namespaceStringToId","source":{"path":"src/core/server/saved_objects/service/lib/utils.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L43"},"returnComment":[]},{"id":"def-server.SavedObjectsUtils.createEmptyFindResponse","type":"Function","children":[{"type":"Object","label":"{\n page = FIND_DEFAULT_PAGE,\n perPage = FIND_DEFAULT_PER_PAGE,\n }","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsFindOptions","text":"SavedObjectsFindOptions"}],"description":[],"source":{"path":"src/core/server/saved_objects/service/lib/utils.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L54"}}],"signature":["({ page, perPage, }: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsFindOptions","text":"SavedObjectsFindOptions"},") => ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsFindResponse","text":"SavedObjectsFindResponse"},""],"description":["\nCreates an empty response for a find operation. This is only intended to be used by saved objects client wrappers."],"label":"createEmptyFindResponse","source":{"path":"src/core/server/saved_objects/service/lib/utils.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L54"},"returnComment":[]},{"id":"def-server.SavedObjectsUtils.generateId","type":"Function","label":"generateId","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsUtils","text":"SavedObjectsUtils"},".generateId"],"description":["\nGenerates a random ID for a saved objects."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/utils.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L67"}},{"id":"def-server.SavedObjectsUtils.isRandomId","type":"Function","label":"isRandomId","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsUtils","text":"SavedObjectsUtils"},".isRandomId"],"description":["\nValidates that a saved object ID has been randomly generated.\n"],"children":[{"type":"string","label":"id","isRequired":false,"signature":["string | undefined"],"description":["The ID of a saved object."],"source":{"path":"src/core/server/saved_objects/service/lib/utils.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L77"}}],"tags":["todo"],"returnComment":[],"source":{"path":"src/core/server/saved_objects/service/lib/utils.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L77"}}],"source":{"path":"src/core/server/saved_objects/service/lib/utils.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/utils.ts#L22"},"initialIsOpen":false},{"id":"def-server.SavedObjectsExporter","type":"Class","label":"SavedObjectsExporter","description":[],"children":[{"id":"def-server.SavedObjectsExporter.#savedObjectsClient","type":"Object","label":"#savedObjectsClient","description":[],"source":{"path":"src/core/server/saved_objects/export/saved_objects_exporter.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L38"},"signature":["Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">"]},{"id":"def-server.SavedObjectsExporter.#exportTransforms","type":"Object","label":"#exportTransforms","description":[],"source":{"path":"src/core/server/saved_objects/export/saved_objects_exporter.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L39"},"signature":["Record"]},{"id":"def-server.SavedObjectsExporter.#exportSizeLimit","type":"number","label":"#exportSizeLimit","description":[],"source":{"path":"src/core/server/saved_objects/export/saved_objects_exporter.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L40"}},{"id":"def-server.SavedObjectsExporter.#log","type":"Object","label":"#log","description":[],"source":{"path":"src/core/server/saved_objects/export/saved_objects_exporter.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L41"},"signature":["Logger"]},{"id":"def-server.SavedObjectsExporter.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"id":"def-server.SavedObjectsExporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n exportSizeLimit,\n logger,\n }","type":"Object","label":"{\n savedObjectsClient,\n typeRegistry,\n exportSizeLimit,\n logger,\n }","description":[],"children":[{"id":"def-server.SavedObjectsExporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n exportSizeLimit,\n logger,\n }.savedObjectsClient","type":"Object","label":"savedObjectsClient","description":[],"source":{"path":"src/core/server/saved_objects/export/saved_objects_exporter.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L49"},"signature":["Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">"]},{"id":"def-server.SavedObjectsExporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n exportSizeLimit,\n logger,\n }.typeRegistry","type":"Object","label":"typeRegistry","description":[],"source":{"path":"src/core/server/saved_objects/export/saved_objects_exporter.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L50"},"signature":["Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectTypeRegistry","text":"SavedObjectTypeRegistry"},", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">"]},{"id":"def-server.SavedObjectsExporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n exportSizeLimit,\n logger,\n }.exportSizeLimit","type":"number","label":"exportSizeLimit","description":[],"source":{"path":"src/core/server/saved_objects/export/saved_objects_exporter.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L51"}},{"id":"def-server.SavedObjectsExporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n exportSizeLimit,\n logger,\n }.logger","type":"Object","label":"logger","description":[],"source":{"path":"src/core/server/saved_objects/export/saved_objects_exporter.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L52"},"signature":["Logger"]}],"source":{"path":"src/core/server/saved_objects/export/saved_objects_exporter.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L48"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/export/saved_objects_exporter.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L43"}},{"id":"def-server.SavedObjectsExporter.exportByTypes","type":"Function","label":"exportByTypes","signature":["(options: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsExportByTypeOptions","text":"SavedObjectsExportByTypeOptions"},") => Promise<","Readable",">"],"description":["\nGenerates an export stream for given types.\n\nSee the {@link SavedObjectsExportByTypeOptions | options} for more detailed information.\n"],"children":[{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsExportByTypeOptions","text":"SavedObjectsExportByTypeOptions"}],"description":[],"source":{"path":"src/core/server/saved_objects/export/saved_objects_exporter.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L75"}}],"tags":["throws"],"returnComment":[],"source":{"path":"src/core/server/saved_objects/export/saved_objects_exporter.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L75"}},{"id":"def-server.SavedObjectsExporter.exportByObjects","type":"Function","label":"exportByObjects","signature":["(options: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsExportByObjectOptions","text":"SavedObjectsExportByObjectOptions"},") => Promise<","Readable",">"],"description":["\nGenerates an export stream for given object references.\n\nSee the {@link SavedObjectsExportByObjectOptions | options} for more detailed information.\n"],"children":[{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsExportByObjectOptions","text":"SavedObjectsExportByObjectOptions"}],"description":[],"source":{"path":"src/core/server/saved_objects/export/saved_objects_exporter.ts","lineNumber":93,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L93"}}],"tags":["throws"],"returnComment":[],"source":{"path":"src/core/server/saved_objects/export/saved_objects_exporter.ts","lineNumber":93,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L93"}}],"source":{"path":"src/core/server/saved_objects/export/saved_objects_exporter.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L37"},"initialIsOpen":false},{"id":"def-server.SavedObjectsExportError","type":"Class","label":"SavedObjectsExportError","description":[],"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsExportError","text":"SavedObjectsExportError"}," extends Error"],"children":[{"id":"def-server.SavedObjectsExportError.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/export/errors.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L16"}},{"type":"string","label":"message","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/core/server/saved_objects/export/errors.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L17"}},{"type":"Object","label":"attributes","isRequired":false,"signature":["Record | undefined"],"description":[],"source":{"path":"src/core/server/saved_objects/export/errors.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L18"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/export/errors.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L15"}},{"id":"def-server.SavedObjectsExportError.exportSizeExceeded","type":"Function","label":"exportSizeExceeded","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsExportError","text":"SavedObjectsExportError"},".exportSizeExceeded"],"description":[],"children":[{"type":"number","label":"limit","isRequired":true,"signature":["number"],"description":[],"source":{"path":"src/core/server/saved_objects/export/errors.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L27"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/export/errors.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L27"}},{"id":"def-server.SavedObjectsExportError.objectFetchError","type":"Function","label":"objectFetchError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsExportError","text":"SavedObjectsExportError"},".objectFetchError"],"description":[],"children":[{"type":"Array","label":"objects","isRequired":true,"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},"[]"],"description":[],"source":{"path":"src/core/server/saved_objects/export/errors.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L34"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/export/errors.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L34"}},{"id":"def-server.SavedObjectsExportError.objectTransformError","type":"Function","label":"objectTransformError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsExportError","text":"SavedObjectsExportError"},".objectTransformError"],"description":["\nError returned when a {@link SavedObjectsExportTransform | export tranform} threw an error"],"children":[{"type":"Array","label":"objects","isRequired":true,"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},"[]"],"description":[],"source":{"path":"src/core/server/saved_objects/export/errors.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L43"}},{"type":"Object","label":"cause","isRequired":true,"signature":["Error"],"description":[],"source":{"path":"src/core/server/saved_objects/export/errors.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L43"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/export/errors.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L43"}},{"id":"def-server.SavedObjectsExportError.invalidTransformError","type":"Function","label":"invalidTransformError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsExportError","text":"SavedObjectsExportError"},".invalidTransformError"],"description":["\nError returned when a {@link SavedObjectsExportTransform | export tranform} performed an invalid operation\nduring the transform, such as removing objects from the export, or changing an object's type or id."],"children":[{"type":"Array","label":"objectKeys","isRequired":true,"signature":["string[]"],"description":[],"source":{"path":"src/core/server/saved_objects/export/errors.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L58"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/export/errors.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L58"}}],"source":{"path":"src/core/server/saved_objects/export/errors.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/errors.ts#L14"},"initialIsOpen":false},{"id":"def-server.SavedObjectsImporter","type":"Class","label":"SavedObjectsImporter","description":[],"children":[{"id":"def-server.SavedObjectsImporter.#savedObjectsClient","type":"Object","label":"#savedObjectsClient","description":[],"source":{"path":"src/core/server/saved_objects/import/saved_objects_importer.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L30"},"signature":["Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">"]},{"id":"def-server.SavedObjectsImporter.#typeRegistry","type":"Object","label":"#typeRegistry","description":[],"source":{"path":"src/core/server/saved_objects/import/saved_objects_importer.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L31"},"signature":["Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectTypeRegistry","text":"SavedObjectTypeRegistry"},", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">"]},{"id":"def-server.SavedObjectsImporter.#importSizeLimit","type":"number","label":"#importSizeLimit","description":[],"source":{"path":"src/core/server/saved_objects/import/saved_objects_importer.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L32"}},{"id":"def-server.SavedObjectsImporter.#importHooks","type":"Object","label":"#importHooks","description":[],"source":{"path":"src/core/server/saved_objects/import/saved_objects_importer.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L33"},"signature":["Record[]>"]},{"id":"def-server.SavedObjectsImporter.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"id":"def-server.SavedObjectsImporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n importSizeLimit,\n }","type":"Object","label":"{\n savedObjectsClient,\n typeRegistry,\n importSizeLimit,\n }","description":[],"children":[{"id":"def-server.SavedObjectsImporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n importSizeLimit,\n }.savedObjectsClient","type":"Object","label":"savedObjectsClient","description":[],"source":{"path":"src/core/server/saved_objects/import/saved_objects_importer.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L40"},"signature":["Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">"]},{"id":"def-server.SavedObjectsImporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n importSizeLimit,\n }.typeRegistry","type":"Object","label":"typeRegistry","description":[],"source":{"path":"src/core/server/saved_objects/import/saved_objects_importer.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L41"},"signature":["Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectTypeRegistry","text":"SavedObjectTypeRegistry"},", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">"]},{"id":"def-server.SavedObjectsImporter.Unnamed.{\n- savedObjectsClient,\n typeRegistry,\n importSizeLimit,\n }.importSizeLimit","type":"number","label":"importSizeLimit","description":[],"source":{"path":"src/core/server/saved_objects/import/saved_objects_importer.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L42"}}],"source":{"path":"src/core/server/saved_objects/import/saved_objects_importer.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L39"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/import/saved_objects_importer.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L35"}},{"id":"def-server.SavedObjectsImporter.import","type":"Function","label":"import","signature":["({ readStream, createNewCopies, namespace, overwrite, }: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportOptions","text":"SavedObjectsImportOptions"},") => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportResponse","text":"SavedObjectsImportResponse"},">"],"description":["\nImport saved objects from given stream. See the {@link SavedObjectsImportOptions | options} for more\ndetailed information.\n"],"children":[{"type":"Object","label":"{\n readStream,\n createNewCopies,\n namespace,\n overwrite,\n }","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportOptions","text":"SavedObjectsImportOptions"}],"description":[],"source":{"path":"src/core/server/saved_objects/import/saved_objects_importer.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L64"}}],"tags":["throws"],"returnComment":[],"source":{"path":"src/core/server/saved_objects/import/saved_objects_importer.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L64"}},{"id":"def-server.SavedObjectsImporter.resolveImportErrors","type":"Function","label":"resolveImportErrors","signature":["({ readStream, createNewCopies, namespace, retries, }: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsResolveImportErrorsOptions","text":"SavedObjectsResolveImportErrorsOptions"},") => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportResponse","text":"SavedObjectsImportResponse"},">"],"description":["\nResolve and return saved object import errors.\nSee the {@link SavedObjectsResolveImportErrorsOptions | options} for more detailed informations.\n"],"children":[{"type":"Object","label":"{\n readStream,\n createNewCopies,\n namespace,\n retries,\n }","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsResolveImportErrorsOptions","text":"SavedObjectsResolveImportErrorsOptions"}],"description":[],"source":{"path":"src/core/server/saved_objects/import/saved_objects_importer.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L88"}}],"tags":["throws"],"returnComment":[],"source":{"path":"src/core/server/saved_objects/import/saved_objects_importer.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L88"}}],"source":{"path":"src/core/server/saved_objects/import/saved_objects_importer.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L29"},"initialIsOpen":false},{"id":"def-server.SavedObjectsImportError","type":"Class","label":"SavedObjectsImportError","description":[],"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportError","text":"SavedObjectsImportError"}," extends Error"],"children":[{"id":"def-server.SavedObjectsImportError.importSizeExceeded","type":"Function","label":"importSizeExceeded","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportError","text":"SavedObjectsImportError"},".importSizeExceeded"],"description":[],"children":[{"type":"number","label":"limit","isRequired":true,"signature":["number"],"description":[],"source":{"path":"src/core/server/saved_objects/import/errors.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L27"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/import/errors.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L27"}},{"id":"def-server.SavedObjectsImportError.nonUniqueImportObjects","type":"Function","label":"nonUniqueImportObjects","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportError","text":"SavedObjectsImportError"},".nonUniqueImportObjects"],"description":[],"children":[{"type":"Array","label":"nonUniqueEntries","isRequired":true,"signature":["string[]"],"description":[],"source":{"path":"src/core/server/saved_objects/import/errors.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L34"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/import/errors.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L34"}},{"id":"def-server.SavedObjectsImportError.nonUniqueRetryObjects","type":"Function","label":"nonUniqueRetryObjects","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportError","text":"SavedObjectsImportError"},".nonUniqueRetryObjects"],"description":[],"children":[{"type":"Array","label":"nonUniqueRetryObjects","isRequired":true,"signature":["string[]"],"description":[],"source":{"path":"src/core/server/saved_objects/import/errors.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L41"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/import/errors.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L41"}},{"id":"def-server.SavedObjectsImportError.nonUniqueRetryDestinations","type":"Function","label":"nonUniqueRetryDestinations","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportError","text":"SavedObjectsImportError"},".nonUniqueRetryDestinations"],"description":[],"children":[{"type":"Array","label":"nonUniqueRetryDestinations","isRequired":true,"signature":["string[]"],"description":[],"source":{"path":"src/core/server/saved_objects/import/errors.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L48"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/import/errors.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L48"}},{"id":"def-server.SavedObjectsImportError.referencesFetchError","type":"Function","label":"referencesFetchError","signature":["typeof ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportError","text":"SavedObjectsImportError"},".referencesFetchError"],"description":[],"children":[{"type":"Array","label":"objects","isRequired":true,"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},"[]"],"description":[],"source":{"path":"src/core/server/saved_objects/import/errors.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L55"}}],"tags":[],"returnComment":[],"source":{"path":"src/core/server/saved_objects/import/errors.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L55"}}],"source":{"path":"src/core/server/saved_objects/import/errors.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/errors.ts#L14"},"initialIsOpen":false}],"functions":[],"interfaces":[{"id":"def-server.SavedObjectsBulkCreateObject","type":"Interface","label":"SavedObjectsBulkCreateObject","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBulkCreateObject","text":"SavedObjectsBulkCreateObject"},""],"description":["\n"],"children":[{"id":"def-server.SavedObjectsBulkCreateObject.id","type":"string","label":"id","description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L66"},"signature":["string | undefined"]},{"id":"def-server.SavedObjectsBulkCreateObject.type","type":"string","label":"type","description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L67"}},{"id":"def-server.SavedObjectsBulkCreateObject.attributes","type":"Uncategorized","label":"attributes","description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L68"},"signature":["T"]},{"id":"def-server.SavedObjectsBulkCreateObject.version","type":"string","label":"version","description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L69"},"signature":["string | undefined"]},{"id":"def-server.SavedObjectsBulkCreateObject.references","type":"Array","label":"references","description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L70"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[] | undefined"]},{"id":"def-server.SavedObjectsBulkCreateObject.migrationVersion","type":"Object","label":"migrationVersion","description":["{@inheritDoc SavedObjectsMigrationVersion}"],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L72"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectsMigrationVersion","text":"SavedObjectsMigrationVersion"}," | undefined"]},{"id":"def-server.SavedObjectsBulkCreateObject.coreMigrationVersion","type":"string","label":"coreMigrationVersion","description":["\nA semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current\nKibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the\ncurrent Kibana version, it will result in an error.\n"],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L82"},"signature":["string | undefined"]},{"id":"def-server.SavedObjectsBulkCreateObject.originId","type":"string","label":"originId","description":["Optional ID of the original saved object, if this object's `id` was regenerated"],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L84"},"signature":["string | undefined"]},{"id":"def-server.SavedObjectsBulkCreateObject.initialNamespaces","type":"Array","label":"initialNamespaces","description":["\nOptional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in\n{@link SavedObjectsCreateOptions}.\n\nNote: this can only be used for multi-namespace object types."],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":91,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L91"},"signature":["string[] | undefined"]}],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L65"},"initialIsOpen":false},{"id":"def-server.SavedObjectsBulkGetObject","type":"Interface","label":"SavedObjectsBulkGetObject","description":["\n"],"children":[{"id":"def-server.SavedObjectsBulkGetObject.id","type":"string","label":"id","description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":294,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L294"}},{"id":"def-server.SavedObjectsBulkGetObject.type","type":"string","label":"type","description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":295,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L295"}},{"id":"def-server.SavedObjectsBulkGetObject.fields","type":"Array","label":"fields","description":["SavedObject fields to include in the response"],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":297,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L297"},"signature":["string[] | undefined"]}],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":293,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L293"},"initialIsOpen":false},{"id":"def-server.SavedObjectsBulkUpdateObject","type":"Interface","label":"SavedObjectsBulkUpdateObject","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBulkUpdateObject","text":"SavedObjectsBulkUpdateObject"}," extends Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsUpdateOptions","text":"SavedObjectsUpdateOptions"},", \"version\" | \"references\">"],"description":["\n"],"children":[{"id":"def-server.SavedObjectsBulkUpdateObject.id","type":"string","label":"id","description":["The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`"],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L101"}},{"id":"def-server.SavedObjectsBulkUpdateObject.type","type":"string","label":"type","description":[" The type of this Saved Object. Each plugin can define it's own custom Saved Object types."],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L103"}},{"id":"def-server.SavedObjectsBulkUpdateObject.attributes","type":"Object","label":"attributes","description":["{@inheritdoc SavedObjectAttributes}"],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":105,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L105"},"signature":["Partial"]},{"id":"def-server.SavedObjectsBulkUpdateObject.namespace","type":"string","label":"namespace","description":["\nOptional namespace string to use when searching for this object. If this is defined, it will supersede the namespace ID that is in\n{@link SavedObjectsBulkUpdateOptions}.\n\nNote: the default namespace's string representation is `'default'`, and its ID representation is `undefined`."],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":112,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L112"},"signature":["string | undefined"]}],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L98"},"initialIsOpen":false},{"id":"def-server.SavedObjectsBulkUpdateOptions","type":"Interface","label":"SavedObjectsBulkUpdateOptions","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBulkUpdateOptions","text":"SavedObjectsBulkUpdateOptions"}," extends ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"}],"description":["\n"],"children":[{"id":"def-server.SavedObjectsBulkUpdateOptions.refresh","type":"CompoundType","label":"refresh","description":["The Elasticsearch Refresh setting for this operation"],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":275,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L275"},"signature":["boolean | \"wait_for\" | undefined"]}],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":273,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L273"},"initialIsOpen":false},{"id":"def-server.SavedObjectsBulkResponse","type":"Interface","label":"SavedObjectsBulkResponse","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBulkResponse","text":"SavedObjectsBulkResponse"},""],"description":["\n"],"children":[{"id":"def-server.SavedObjectsBulkResponse.saved_objects","type":"Array","label":"saved_objects","description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":120,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L120"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},"[]"]}],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":119,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L119"},"initialIsOpen":false},{"id":"def-server.SavedObjectsBulkResponse","type":"Interface","label":"SavedObjectsBulkResponse","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBulkResponse","text":"SavedObjectsBulkResponse"},""],"description":["\n"],"children":[{"id":"def-server.SavedObjectsBulkResponse.saved_objects","type":"Array","label":"saved_objects","description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":305,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L305"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},"[]"]}],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":304,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L304"},"initialIsOpen":false},{"id":"def-server.SavedObjectsBulkUpdateResponse","type":"Interface","label":"SavedObjectsBulkUpdateResponse","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBulkUpdateResponse","text":"SavedObjectsBulkUpdateResponse"},""],"description":["\n"],"children":[{"id":"def-server.SavedObjectsBulkUpdateResponse.saved_objects","type":"Array","label":"saved_objects","description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":313,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L313"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsUpdateResponse","text":"SavedObjectsUpdateResponse"},"[]"]}],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":312,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L312"},"initialIsOpen":false},{"id":"def-server.SavedObjectsCheckConflictsObject","type":"Interface","label":"SavedObjectsCheckConflictsObject","description":["\n"],"children":[{"id":"def-server.SavedObjectsCheckConflictsObject.id","type":"string","label":"id","description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":184,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L184"}},{"id":"def-server.SavedObjectsCheckConflictsObject.type","type":"string","label":"type","description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":185,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L185"}}],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":183,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L183"},"initialIsOpen":false},{"id":"def-server.SavedObjectsCheckConflictsResponse","type":"Interface","label":"SavedObjectsCheckConflictsResponse","description":["\n"],"children":[{"id":"def-server.SavedObjectsCheckConflictsResponse.errors","type":"Array","label":"errors","description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":193,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L193"},"signature":["{ id: string; type: string; error: ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectError","text":"SavedObjectError"},"; }[]"]}],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":192,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L192"},"initialIsOpen":false},{"id":"def-server.SavedObjectsClientProviderOptions","type":"Interface","label":"SavedObjectsClientProviderOptions","description":["\nOptions to control the creation of the Saved Objects Client."],"children":[{"id":"def-server.SavedObjectsClientProviderOptions.excludedWrappers","type":"Array","label":"excludedWrappers","description":[],"source":{"path":"src/core/server/saved_objects/service/lib/scoped_client_provider.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/scoped_client_provider.ts#L58"},"signature":["string[] | undefined"]},{"id":"def-server.SavedObjectsClientProviderOptions.includedHiddenTypes","type":"Array","label":"includedHiddenTypes","description":[],"source":{"path":"src/core/server/saved_objects/service/lib/scoped_client_provider.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/scoped_client_provider.ts#L59"},"signature":["string[] | undefined"]}],"source":{"path":"src/core/server/saved_objects/service/lib/scoped_client_provider.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/scoped_client_provider.ts#L57"},"initialIsOpen":false},{"id":"def-server.SavedObjectsClientWrapperOptions","type":"Interface","label":"SavedObjectsClientWrapperOptions","description":["\nOptions passed to each SavedObjectsClientWrapperFactory to aid in creating the wrapper instance."],"children":[{"id":"def-server.SavedObjectsClientWrapperOptions.client","type":"Object","label":"client","description":[],"source":{"path":"src/core/server/saved_objects/service/lib/scoped_client_provider.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/scoped_client_provider.ts#L20"},"signature":["Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">"]},{"id":"def-server.SavedObjectsClientWrapperOptions.typeRegistry","type":"Object","label":"typeRegistry","description":[],"source":{"path":"src/core/server/saved_objects/service/lib/scoped_client_provider.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/scoped_client_provider.ts#L21"},"signature":["Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectTypeRegistry","text":"SavedObjectTypeRegistry"},", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">"]},{"id":"def-server.SavedObjectsClientWrapperOptions.request","type":"Object","label":"request","description":[],"source":{"path":"src/core/server/saved_objects/service/lib/scoped_client_provider.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/scoped_client_provider.ts#L22"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},""]}],"source":{"path":"src/core/server/saved_objects/service/lib/scoped_client_provider.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/scoped_client_provider.ts#L19"},"initialIsOpen":false},{"id":"def-server.SavedObjectsClosePointInTimeResponse","type":"Interface","label":"SavedObjectsClosePointInTimeResponse","description":[],"children":[{"id":"def-server.SavedObjectsClosePointInTimeResponse.succeeded","type":"boolean","label":"succeeded","description":["\nIf true, all search contexts associated with the PIT id are\nsuccessfully closed."],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":385,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L385"}},{"id":"def-server.SavedObjectsClosePointInTimeResponse.num_freed","type":"number","label":"num_freed","description":["\nThe number of search contexts that have been successfully closed."],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":389,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L389"}}],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":380,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L380"},"initialIsOpen":false},{"id":"def-server.SavedObjectsCreateOptions","type":"Interface","label":"SavedObjectsCreateOptions","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsCreateOptions","text":"SavedObjectsCreateOptions"}," extends ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"}],"description":["\n"],"children":[{"id":"def-server.SavedObjectsCreateOptions.id","type":"string","label":"id","description":["(not recommended) Specify an id for the document"],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L27"},"signature":["string | undefined"]},{"id":"def-server.SavedObjectsCreateOptions.overwrite","type":"CompoundType","label":"overwrite","description":["Overwrite existing documents (defaults to false)"],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L29"},"signature":["boolean | undefined"]},{"id":"def-server.SavedObjectsCreateOptions.version","type":"string","label":"version","description":["\nAn opaque version number which changes on each successful write operation.\nCan be used in conjunction with `overwrite` for implementing optimistic concurrency control."],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L34"},"signature":["string | undefined"]},{"id":"def-server.SavedObjectsCreateOptions.migrationVersion","type":"Object","label":"migrationVersion","description":["{@inheritDoc SavedObjectsMigrationVersion}"],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L36"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectsMigrationVersion","text":"SavedObjectsMigrationVersion"}," | undefined"]},{"id":"def-server.SavedObjectsCreateOptions.coreMigrationVersion","type":"string","label":"coreMigrationVersion","description":["\nA semver value that is used when upgrading objects between Kibana versions. If undefined, this will be automatically set to the current\nKibana version when the object is created. If this is set to a non-semver value, or it is set to a semver value greater than the\ncurrent Kibana version, it will result in an error.\n"],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L46"},"signature":["string | undefined"]},{"id":"def-server.SavedObjectsCreateOptions.references","type":"Array","label":"references","description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L47"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[] | undefined"]},{"id":"def-server.SavedObjectsCreateOptions.refresh","type":"CompoundType","label":"refresh","description":["The Elasticsearch Refresh setting for this operation"],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L49"},"signature":["boolean | \"wait_for\" | undefined"]},{"id":"def-server.SavedObjectsCreateOptions.originId","type":"string","label":"originId","description":["Optional ID of the original saved object, if this object's `id` was regenerated"],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L51"},"signature":["string | undefined"]},{"id":"def-server.SavedObjectsCreateOptions.initialNamespaces","type":"Array","label":"initialNamespaces","description":["\nOptional initial namespaces for the object to be created in. If this is defined, it will supersede the namespace ID that is in\n{@link SavedObjectsCreateOptions}.\n\nNote: this can only be used for multi-namespace object types."],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L58"},"signature":["string[] | undefined"]}],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L25"},"initialIsOpen":false},{"id":"def-server.SavedObjectsExportResultDetails","type":"Interface","label":"SavedObjectsExportResultDetails","description":["\nStructure of the export result details entry"],"children":[{"id":"def-server.SavedObjectsExportResultDetails.exportedCount","type":"number","label":"exportedCount","description":["number of successfully exported objects"],"source":{"path":"src/core/server/saved_objects/export/types.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L59"}},{"id":"def-server.SavedObjectsExportResultDetails.missingRefCount","type":"number","label":"missingRefCount","description":["number of missing references"],"source":{"path":"src/core/server/saved_objects/export/types.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L61"}},{"id":"def-server.SavedObjectsExportResultDetails.missingReferences","type":"Array","label":"missingReferences","description":["missing references details"],"source":{"path":"src/core/server/saved_objects/export/types.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L63"},"signature":["{ id: string; type: string; }[]"]}],"source":{"path":"src/core/server/saved_objects/export/types.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L57"},"initialIsOpen":false},{"id":"def-server.SavedObjectsFindResult","type":"Interface","label":"SavedObjectsFindResult","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsFindResult","text":"SavedObjectsFindResult"}," extends ","SavedObject",""],"description":["\n"],"children":[{"id":"def-server.SavedObjectsFindResult.score","type":"number","label":"score","description":["\nThe Elasticsearch `_score` of this result."],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L131"}},{"id":"def-server.SavedObjectsFindResult.sort","type":"Array","label":"sort","description":["\nThe Elasticsearch `sort` value of this result.\n"],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":160,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L160"},"signature":["unknown[] | undefined"]}],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":127,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L127"},"initialIsOpen":false},{"id":"def-server.SavedObjectsFindResponse","type":"Interface","label":"SavedObjectsFindResponse","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsFindResponse","text":"SavedObjectsFindResponse"},""],"description":["\nReturn type of the Saved Objects `find()` method.\n\n*Note*: this type is different between the Public and Server Saved Objects\nclients.\n"],"children":[{"id":"def-server.SavedObjectsFindResponse.saved_objects","type":"Array","label":"saved_objects","description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":172,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L172"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsFindResult","text":"SavedObjectsFindResult"},"[]"]},{"id":"def-server.SavedObjectsFindResponse.total","type":"number","label":"total","description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":173,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L173"}},{"id":"def-server.SavedObjectsFindResponse.per_page","type":"number","label":"per_page","description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":174,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L174"}},{"id":"def-server.SavedObjectsFindResponse.page","type":"number","label":"page","description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":175,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L175"}},{"id":"def-server.SavedObjectsFindResponse.pit_id","type":"string","label":"pit_id","description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":176,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L176"},"signature":["string | undefined"]}],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":171,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L171"},"initialIsOpen":false},{"id":"def-server.SavedObjectsImportConflictError","type":"Interface","label":"SavedObjectsImportConflictError","description":["\nRepresents a failure to import due to a conflict."],"children":[{"id":"def-server.SavedObjectsImportConflictError.type","type":"string","label":"type","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L45"},"signature":["\"conflict\""]},{"id":"def-server.SavedObjectsImportConflictError.destinationId","type":"string","label":"destinationId","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L46"},"signature":["string | undefined"]}],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L44"},"initialIsOpen":false},{"id":"def-server.SavedObjectsImportAmbiguousConflictError","type":"Interface","label":"SavedObjectsImportAmbiguousConflictError","description":["\nRepresents a failure to import due to a conflict, which can be resolved in different ways with an overwrite."],"children":[{"id":"def-server.SavedObjectsImportAmbiguousConflictError.type","type":"string","label":"type","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L54"},"signature":["\"ambiguous_conflict\""]},{"id":"def-server.SavedObjectsImportAmbiguousConflictError.destinations","type":"Array","label":"destinations","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L55"},"signature":["{ id: string; title?: string | undefined; updatedAt?: string | undefined; }[]"]}],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L53"},"initialIsOpen":false},{"id":"def-server.SavedObjectsImportFailure","type":"Interface","label":"SavedObjectsImportFailure","description":["\nRepresents a failure to import."],"children":[{"id":"def-server.SavedObjectsImportFailure.id","type":"string","label":"id","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L90"}},{"id":"def-server.SavedObjectsImportFailure.type","type":"string","label":"type","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":91,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L91"}},{"id":"def-server.SavedObjectsImportFailure.title","type":"string","label":"title","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L95"},"signature":["string | undefined"]},{"id":"def-server.SavedObjectsImportFailure.meta","type":"Object","label":"meta","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L96"},"signature":["{ title?: string | undefined; icon?: string | undefined; }"]},{"id":"def-server.SavedObjectsImportFailure.overwrite","type":"CompoundType","label":"overwrite","description":["\nIf `overwrite` is specified, an attempt was made to overwrite an existing object."],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":100,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L100"},"signature":["boolean | undefined"]},{"id":"def-server.SavedObjectsImportFailure.error","type":"CompoundType","label":"error","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L101"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportConflictError","text":"SavedObjectsImportConflictError"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportAmbiguousConflictError","text":"SavedObjectsImportAmbiguousConflictError"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportUnsupportedTypeError","text":"SavedObjectsImportUnsupportedTypeError"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportMissingReferencesError","text":"SavedObjectsImportMissingReferencesError"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportUnknownError","text":"SavedObjectsImportUnknownError"}]}],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L89"},"initialIsOpen":false},{"id":"def-server.SavedObjectsImportMissingReferencesError","type":"Interface","label":"SavedObjectsImportMissingReferencesError","description":["\nRepresents a failure to import due to missing references."],"children":[{"id":"def-server.SavedObjectsImportMissingReferencesError.type","type":"string","label":"type","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L81"},"signature":["\"missing_references\""]},{"id":"def-server.SavedObjectsImportMissingReferencesError.references","type":"Array","label":"references","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L82"},"signature":["{ type: string; id: string; }[]"]}],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L80"},"initialIsOpen":false},{"id":"def-server.SavedObjectsImportOptions","type":"Interface","label":"SavedObjectsImportOptions","description":["\nOptions to control the import operation."],"children":[{"id":"def-server.SavedObjectsImportOptions.readStream","type":"Object","label":"readStream","description":["The stream of {@link SavedObject | saved objects} to import"],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":155,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L155"},"signature":["Readable"]},{"id":"def-server.SavedObjectsImportOptions.overwrite","type":"boolean","label":"overwrite","description":["If true, will override existing object if present. Note: this has no effect when used with the `createNewCopies` option."],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":157,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L157"}},{"id":"def-server.SavedObjectsImportOptions.namespace","type":"string","label":"namespace","description":["if specified, will import in given namespace, else will import as global object"],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":159,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L159"},"signature":["string | undefined"]},{"id":"def-server.SavedObjectsImportOptions.createNewCopies","type":"boolean","label":"createNewCopies","description":["If true, will create new copies of import objects, each with a random `id` and undefined `originId`."],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":161,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L161"}}],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":153,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L153"},"initialIsOpen":false},{"id":"def-server.SavedObjectsImportResponse","type":"Interface","label":"SavedObjectsImportResponse","description":["\nThe response describing the result of an import."],"children":[{"id":"def-server.SavedObjectsImportResponse.success","type":"boolean","label":"success","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":142,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L142"}},{"id":"def-server.SavedObjectsImportResponse.successCount","type":"number","label":"successCount","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":143,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L143"}},{"id":"def-server.SavedObjectsImportResponse.successResults","type":"Array","label":"successResults","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":144,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L144"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportSuccess","text":"SavedObjectsImportSuccess"},"[] | undefined"]},{"id":"def-server.SavedObjectsImportResponse.warnings","type":"Array","label":"warnings","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":145,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L145"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportWarning","text":"SavedObjectsImportWarning"},"[]"]},{"id":"def-server.SavedObjectsImportResponse.errors","type":"Array","label":"errors","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":146,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L146"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportFailure","text":"SavedObjectsImportFailure"},"[] | undefined"]}],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":141,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L141"},"initialIsOpen":false},{"id":"def-server.SavedObjectsImportRetry","type":"Interface","label":"SavedObjectsImportRetry","description":["\nDescribes a retry operation for importing a saved object."],"children":[{"id":"def-server.SavedObjectsImportRetry.type","type":"string","label":"type","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L17"}},{"id":"def-server.SavedObjectsImportRetry.id","type":"string","label":"id","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L18"}},{"id":"def-server.SavedObjectsImportRetry.overwrite","type":"boolean","label":"overwrite","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L19"}},{"id":"def-server.SavedObjectsImportRetry.destinationId","type":"string","label":"destinationId","description":["\nThe object ID that will be created or overwritten. If not specified, the `id` field will be used."],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L23"},"signature":["string | undefined"]},{"id":"def-server.SavedObjectsImportRetry.replaceReferences","type":"Array","label":"replaceReferences","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L24"},"signature":["{ type: string; from: string; to: string; }[]"]},{"id":"def-server.SavedObjectsImportRetry.createNewCopy","type":"CompoundType","label":"createNewCopy","description":["\nIf `createNewCopy` is specified, the new object has a new (undefined) origin ID. This is only needed for the case where\n`createNewCopies` mode is disabled and ambiguous source conflicts are detected."],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L33"},"signature":["boolean | undefined"]},{"id":"def-server.SavedObjectsImportRetry.ignoreMissingReferences","type":"CompoundType","label":"ignoreMissingReferences","description":["\nIf `ignoreMissingReferences` is specified, reference validation will be skipped for this object."],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L37"},"signature":["boolean | undefined"]}],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L16"},"initialIsOpen":false},{"id":"def-server.SavedObjectsImportSuccess","type":"Interface","label":"SavedObjectsImportSuccess","description":["\nRepresents a successful import."],"children":[{"id":"def-server.SavedObjectsImportSuccess.id","type":"string","label":"id","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":114,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L114"}},{"id":"def-server.SavedObjectsImportSuccess.type","type":"string","label":"type","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L115"}},{"id":"def-server.SavedObjectsImportSuccess.destinationId","type":"string","label":"destinationId","description":["\nIf `destinationId` is specified, the new object has a new ID that is different from the import ID."],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":119,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L119"},"signature":["string | undefined"]},{"id":"def-server.SavedObjectsImportSuccess.createNewCopy","type":"CompoundType","label":"createNewCopy","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":126,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L126"},"signature":["boolean | undefined"]},{"id":"def-server.SavedObjectsImportSuccess.meta","type":"Object","label":"meta","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":127,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L127"},"signature":["{ title?: string | undefined; icon?: string | undefined; }"]},{"id":"def-server.SavedObjectsImportSuccess.overwrite","type":"CompoundType","label":"overwrite","description":["\nIf `overwrite` is specified, this object overwrote an existing one (or will do so, in the case of a pending resolution)."],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":134,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L134"},"signature":["boolean | undefined"]}],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":113,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L113"},"initialIsOpen":false},{"id":"def-server.SavedObjectsImportUnknownError","type":"Interface","label":"SavedObjectsImportUnknownError","description":["\nRepresents a failure to import due to an unknown reason."],"children":[{"id":"def-server.SavedObjectsImportUnknownError.type","type":"string","label":"type","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L71"},"signature":["\"unknown\""]},{"id":"def-server.SavedObjectsImportUnknownError.message","type":"string","label":"message","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L72"}},{"id":"def-server.SavedObjectsImportUnknownError.statusCode","type":"number","label":"statusCode","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L73"}}],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L70"},"initialIsOpen":false},{"id":"def-server.SavedObjectsImportUnsupportedTypeError","type":"Interface","label":"SavedObjectsImportUnsupportedTypeError","description":["\nRepresents a failure to import due to having an unsupported saved object type."],"children":[{"id":"def-server.SavedObjectsImportUnsupportedTypeError.type","type":"string","label":"type","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L63"},"signature":["\"unsupported_type\""]}],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L62"},"initialIsOpen":false},{"id":"def-server.SavedObjectMigrationContext","type":"Interface","label":"SavedObjectMigrationContext","description":["\nMigration context provided when invoking a {@link SavedObjectMigrationFn | migration handler}\n"],"children":[{"id":"def-server.SavedObjectMigrationContext.log","type":"Object","label":"log","description":["\nlogger instance to be used by the migration handler"],"source":{"path":"src/core/server/saved_objects/migrations/types.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/types.ts#L59"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsMigrationLogger","text":"SavedObjectsMigrationLogger"}]},{"id":"def-server.SavedObjectMigrationContext.migrationVersion","type":"string","label":"migrationVersion","description":["\nThe migration version that this migration function is defined for"],"source":{"path":"src/core/server/saved_objects/migrations/types.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/types.ts#L63"}},{"id":"def-server.SavedObjectMigrationContext.convertToMultiNamespaceTypeVersion","type":"string","label":"convertToMultiNamespaceTypeVersion","description":["\nThe version in which this object type is being converted to a multi-namespace type"],"source":{"path":"src/core/server/saved_objects/migrations/types.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/types.ts#L67"},"signature":["string | undefined"]}],"source":{"path":"src/core/server/saved_objects/migrations/types.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/types.ts#L55"},"initialIsOpen":false},{"id":"def-server.SavedObjectsMigrationLogger","type":"Interface","label":"SavedObjectsMigrationLogger","description":[],"children":[{"id":"def-server.SavedObjectsMigrationLogger.debug","type":"Function","label":"debug","description":[],"source":{"path":"src/core/server/saved_objects/migrations/core/migration_logger.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/core/migration_logger.ts#L20"},"signature":["(msg: string) => void"]},{"id":"def-server.SavedObjectsMigrationLogger.info","type":"Function","label":"info","description":[],"source":{"path":"src/core/server/saved_objects/migrations/core/migration_logger.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/core/migration_logger.ts#L21"},"signature":["(msg: string) => void"]},{"id":"def-server.SavedObjectsMigrationLogger.warning","type":"Function","label":"warning","description":[],"source":{"path":"src/core/server/saved_objects/migrations/core/migration_logger.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/core/migration_logger.ts#L25"},"signature":["(msg: string) => void"]},{"id":"def-server.SavedObjectsMigrationLogger.warn","type":"Function","label":"warn","description":[],"source":{"path":"src/core/server/saved_objects/migrations/core/migration_logger.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/core/migration_logger.ts#L26"},"signature":["(msg: string) => void"]},{"id":"def-server.SavedObjectsMigrationLogger.error","type":"Function","label":"error","description":[],"source":{"path":"src/core/server/saved_objects/migrations/core/migration_logger.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/core/migration_logger.ts#L27"},"signature":["(msg: string, meta: ","LogMeta",") => void"]}],"source":{"path":"src/core/server/saved_objects/migrations/core/migration_logger.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/core/migration_logger.ts#L19"},"initialIsOpen":false},{"id":"def-server.SavedObjectsOpenPointInTimeOptions","type":"Interface","label":"SavedObjectsOpenPointInTimeOptions","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsOpenPointInTimeOptions","text":"SavedObjectsOpenPointInTimeOptions"}," extends ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"}],"description":[],"children":[{"id":"def-server.SavedObjectsOpenPointInTimeOptions.keepAlive","type":"string","label":"keepAlive","description":["\nOptionally specify how long ES should keep the PIT alive until the next request. Defaults to `5m`."],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":355,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L355"},"signature":["string | undefined"]},{"id":"def-server.SavedObjectsOpenPointInTimeOptions.preference","type":"string","label":"preference","description":["\nAn optional ES preference value to be used for the query."],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":359,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L359"},"signature":["string | undefined"]}],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":351,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L351"},"initialIsOpen":false},{"id":"def-server.SavedObjectsOpenPointInTimeResponse","type":"Interface","label":"SavedObjectsOpenPointInTimeResponse","description":[],"children":[{"id":"def-server.SavedObjectsOpenPointInTimeResponse.id","type":"string","label":"id","description":["\nPIT ID returned from ES."],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":369,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L369"}}],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":365,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L365"},"initialIsOpen":false},{"id":"def-server.SavedObjectsRawDoc","type":"Interface","label":"SavedObjectsRawDoc","description":["\nA raw document as represented directly in the saved object index.\n"],"children":[{"id":"def-server.SavedObjectsRawDoc._id","type":"string","label":"_id","description":[],"source":{"path":"src/core/server/saved_objects/serialization/types.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L17"}},{"id":"def-server.SavedObjectsRawDoc._source","type":"Object","label":"_source","description":[],"source":{"path":"src/core/server/saved_objects/serialization/types.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L18"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsRawDocSource","text":"SavedObjectsRawDocSource"}]},{"id":"def-server.SavedObjectsRawDoc._seq_no","type":"number","label":"_seq_no","description":[],"source":{"path":"src/core/server/saved_objects/serialization/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L19"},"signature":["number | undefined"]},{"id":"def-server.SavedObjectsRawDoc._primary_term","type":"number","label":"_primary_term","description":[],"source":{"path":"src/core/server/saved_objects/serialization/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L20"},"signature":["number | undefined"]}],"source":{"path":"src/core/server/saved_objects/serialization/types.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L16"},"initialIsOpen":false},{"id":"def-server.SavedObjectsRawDocParseOptions","type":"Interface","label":"SavedObjectsRawDocParseOptions","description":["\nOptions that can be specified when using the saved objects serializer to parse a raw document.\n"],"children":[{"id":"def-server.SavedObjectsRawDocParseOptions.namespaceTreatment","type":"CompoundType","label":"namespaceTreatment","description":["\nOptional setting to allow for lax handling of the raw document ID and namespace field. This is needed when a previously\nsingle-namespace object type is converted to a multi-namespace object type, and it is only intended to be used during upgrade\nmigrations.\n\nIf not specified, the default treatment is `strict`."],"source":{"path":"src/core/server/saved_objects/serialization/types.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L86"},"signature":["\"strict\" | \"lax\" | undefined"]}],"source":{"path":"src/core/server/saved_objects/serialization/types.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L78"},"initialIsOpen":false},{"id":"def-server.SavedObjectsRepositoryFactory","type":"Interface","label":"SavedObjectsRepositoryFactory","description":["\nFactory provided when invoking a {@link SavedObjectsClientFactoryProvider | client factory provider}\nSee {@link SavedObjectsServiceSetup.setClientFactoryProvider}\n"],"children":[{"id":"def-server.SavedObjectsRepositoryFactory.createScopedRepository","type":"Function","label":"createScopedRepository","description":["\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the credentials from the passed in request to authenticate with\nElasticsearch.\n"],"source":{"path":"src/core/server/saved_objects/saved_objects_service.ts","lineNumber":234,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L234"},"signature":["(req: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},", includedHiddenTypes?: string[] | undefined) => Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsRepository","text":"SavedObjectsRepository"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"deleteByNamespace\" | \"incrementCounter\">"]},{"id":"def-server.SavedObjectsRepositoryFactory.createInternalRepository","type":"Function","label":"createInternalRepository","description":["\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the internal Kibana user for authenticating with Elasticsearch.\n"],"source":{"path":"src/core/server/saved_objects/saved_objects_service.ts","lineNumber":244,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L244"},"signature":["(includedHiddenTypes?: string[] | undefined) => Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsRepository","text":"SavedObjectsRepository"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"deleteByNamespace\" | \"incrementCounter\">"]}],"source":{"path":"src/core/server/saved_objects/saved_objects_service.ts","lineNumber":226,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L226"},"initialIsOpen":false},{"id":"def-server.SavedObjectsResolveImportErrorsOptions","type":"Interface","label":"SavedObjectsResolveImportErrorsOptions","description":["\nOptions to control the \"resolve import\" operation."],"children":[{"id":"def-server.SavedObjectsResolveImportErrorsOptions.readStream","type":"Object","label":"readStream","description":["The stream of {@link SavedObject | saved objects} to resolve errors from"],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":170,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L170"},"signature":["Readable"]},{"id":"def-server.SavedObjectsResolveImportErrorsOptions.retries","type":"Array","label":"retries","description":["saved object import references to retry"],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":172,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L172"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportRetry","text":"SavedObjectsImportRetry"},"[]"]},{"id":"def-server.SavedObjectsResolveImportErrorsOptions.namespace","type":"string","label":"namespace","description":["if specified, will import in given namespace"],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":174,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L174"},"signature":["string | undefined"]},{"id":"def-server.SavedObjectsResolveImportErrorsOptions.createNewCopies","type":"boolean","label":"createNewCopies","description":["If true, will create new copies of import objects, each with a random `id` and undefined `originId`."],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":176,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L176"}}],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":168,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L168"},"initialIsOpen":false},{"id":"def-server.SavedObjectsResolveResponse","type":"Interface","label":"SavedObjectsResolveResponse","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsResolveResponse","text":"SavedObjectsResolveResponse"},""],"description":["\n"],"children":[{"id":"def-server.SavedObjectsResolveResponse.saved_object","type":"Object","label":"saved_object","description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":331,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L331"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},""]},{"id":"def-server.SavedObjectsResolveResponse.outcome","type":"CompoundType","label":"outcome","description":["\nThe outcome for a successful `resolve` call is one of the following values:\n\n * `'exactMatch'` -- One document exactly matched the given ID.\n * `'aliasMatch'` -- One document with a legacy URL alias matched the given ID; in this case the `saved_object.id` field is different\n than the given ID.\n * `'conflict'` -- Two documents matched the given ID, one was an exact match and another with a legacy URL alias; in this case the\n `saved_object` object is the exact match, and the `saved_object.id` field is the same as the given ID."],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":341,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L341"},"signature":["\"conflict\" | \"exactMatch\" | \"aliasMatch\""]},{"id":"def-server.SavedObjectsResolveResponse.aliasTargetId","type":"string","label":"aliasTargetId","description":["\nThe ID of the object that the legacy URL alias points to. This is only defined when the outcome is `'aliasMatch'` or `'conflict'`."],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":345,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L345"},"signature":["string | undefined"]}],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":330,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L330"},"initialIsOpen":false},{"id":"def-server.SavedObjectsUpdateOptions","type":"Interface","label":"SavedObjectsUpdateOptions","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsUpdateOptions","text":"SavedObjectsUpdateOptions"}," extends ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"}],"description":["\n"],"children":[{"id":"def-server.SavedObjectsUpdateOptions.version","type":"string","label":"version","description":["An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control."],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":206,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L206"},"signature":["string | undefined"]},{"id":"def-server.SavedObjectsUpdateOptions.references","type":"Array","label":"references","description":["{@inheritdoc SavedObjectReference}"],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":208,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L208"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[] | undefined"]},{"id":"def-server.SavedObjectsUpdateOptions.refresh","type":"CompoundType","label":"refresh","description":["The Elasticsearch Refresh setting for this operation"],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":210,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L210"},"signature":["boolean | \"wait_for\" | undefined"]}],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":204,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L204"},"initialIsOpen":false},{"id":"def-server.SavedObjectsUpdateResponse","type":"Interface","label":"SavedObjectsUpdateResponse","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsUpdateResponse","text":"SavedObjectsUpdateResponse"}," extends Pick<","SavedObject",", \"type\" | \"id\" | \"version\" | \"namespaces\" | \"updated_at\" | \"error\" | \"migrationVersion\" | \"coreMigrationVersion\" | \"originId\">"],"description":["\n"],"children":[{"id":"def-server.SavedObjectsUpdateResponse.attributes","type":"Object","label":"attributes","description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":322,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L322"},"signature":["Partial"]},{"id":"def-server.SavedObjectsUpdateResponse.references","type":"Array","label":"references","description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":323,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L323"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[] | undefined"]}],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":320,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L320"},"initialIsOpen":false},{"id":"def-server.SavedObjectsAddToNamespacesOptions","type":"Interface","label":"SavedObjectsAddToNamespacesOptions","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsAddToNamespacesOptions","text":"SavedObjectsAddToNamespacesOptions"}," extends ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"}],"description":["\n"],"children":[{"id":"def-server.SavedObjectsAddToNamespacesOptions.version","type":"string","label":"version","description":["An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control."],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":219,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L219"},"signature":["string | undefined"]},{"id":"def-server.SavedObjectsAddToNamespacesOptions.refresh","type":"CompoundType","label":"refresh","description":["The Elasticsearch Refresh setting for this operation"],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":221,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L221"},"signature":["boolean | \"wait_for\" | undefined"]}],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":217,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L217"},"initialIsOpen":false},{"id":"def-server.SavedObjectsAddToNamespacesResponse","type":"Interface","label":"SavedObjectsAddToNamespacesResponse","description":["\n"],"children":[{"id":"def-server.SavedObjectsAddToNamespacesResponse.namespaces","type":"Array","label":"namespaces","description":["The namespaces the object exists in after this operation is complete."],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":230,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L230"},"signature":["string[]"]}],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":228,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L228"},"initialIsOpen":false},{"id":"def-server.SavedObjectsDeleteFromNamespacesOptions","type":"Interface","label":"SavedObjectsDeleteFromNamespacesOptions","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsDeleteFromNamespacesOptions","text":"SavedObjectsDeleteFromNamespacesOptions"}," extends ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"}],"description":["\n"],"children":[{"id":"def-server.SavedObjectsDeleteFromNamespacesOptions.refresh","type":"CompoundType","label":"refresh","description":["The Elasticsearch Refresh setting for this operation"],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":239,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L239"},"signature":["boolean | \"wait_for\" | undefined"]}],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":237,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L237"},"initialIsOpen":false},{"id":"def-server.SavedObjectsDeleteFromNamespacesResponse","type":"Interface","label":"SavedObjectsDeleteFromNamespacesResponse","description":["\n"],"children":[{"id":"def-server.SavedObjectsDeleteFromNamespacesResponse.namespaces","type":"Array","label":"namespaces","description":["The namespaces the object exists in after this operation is complete. An empty array indicates the object was deleted."],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":248,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L248"},"signature":["string[]"]}],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":246,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L246"},"initialIsOpen":false},{"id":"def-server.SavedObjectsRemoveReferencesToOptions","type":"Interface","label":"SavedObjectsRemoveReferencesToOptions","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsRemoveReferencesToOptions","text":"SavedObjectsRemoveReferencesToOptions"}," extends ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"}],"description":["\n"],"children":[{"id":"def-server.SavedObjectsRemoveReferencesToOptions.refresh","type":"CompoundType","label":"refresh","description":["The Elasticsearch Refresh setting for this operation. Defaults to `true`"],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":257,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L257"},"signature":["boolean | undefined"]}],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":255,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L255"},"initialIsOpen":false},{"id":"def-server.SavedObjectsRemoveReferencesToResponse","type":"Interface","label":"SavedObjectsRemoveReferencesToResponse","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsRemoveReferencesToResponse","text":"SavedObjectsRemoveReferencesToResponse"}," extends ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"}],"description":["\n"],"children":[{"id":"def-server.SavedObjectsRemoveReferencesToResponse.updated","type":"number","label":"updated","description":["The number of objects that have been updated by this operation"],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":266,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L266"}}],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":264,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L264"},"initialIsOpen":false},{"id":"def-server.SavedObjectsServiceStart","type":"Interface","label":"SavedObjectsServiceStart","description":["\nSaved Objects is Kibana's data persisentence mechanism allowing plugins to\nuse Elasticsearch for storing and querying state. The\nSavedObjectsServiceStart API provides a scoped Saved Objects client for\ninteracting with Saved Objects.\n"],"children":[{"id":"def-server.SavedObjectsServiceStart.getScopedClient","type":"Function","label":"getScopedClient","description":["\nCreates a {@link SavedObjectsClientContract | Saved Objects client} that\nuses the credentials from the passed in request to authenticate with\nElasticsearch. If other plugins have registered Saved Objects client\nwrappers, these will be applied to extend the functionality of the client.\n\nA client that is already scoped to the incoming request is also exposed\nfrom the route handler context see {@link RequestHandlerContext}."],"source":{"path":"src/core/server/saved_objects/saved_objects_service.ts","lineNumber":172,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L172"},"signature":["(req: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},", options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClientProviderOptions","text":"SavedObjectsClientProviderOptions"}," | undefined) => Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">"]},{"id":"def-server.SavedObjectsServiceStart.createScopedRepository","type":"Function","label":"createScopedRepository","description":["\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the credentials from the passed in request to authenticate with\nElasticsearch.\n"],"source":{"path":"src/core/server/saved_objects/saved_objects_service.ts","lineNumber":188,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L188"},"signature":["(req: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},", includedHiddenTypes?: string[] | undefined) => Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsRepository","text":"SavedObjectsRepository"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"deleteByNamespace\" | \"incrementCounter\">"]},{"id":"def-server.SavedObjectsServiceStart.createInternalRepository","type":"Function","label":"createInternalRepository","description":["\nCreates a {@link ISavedObjectsRepository | Saved Objects repository} that\nuses the internal Kibana user for authenticating with Elasticsearch.\n"],"source":{"path":"src/core/server/saved_objects/saved_objects_service.ts","lineNumber":198,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L198"},"signature":["(includedHiddenTypes?: string[] | undefined) => Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsRepository","text":"SavedObjectsRepository"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"deleteByNamespace\" | \"incrementCounter\">"]},{"id":"def-server.SavedObjectsServiceStart.createSerializer","type":"Function","label":"createSerializer","description":["\nCreates a {@link SavedObjectsSerializer | serializer} that is aware of all registered types."],"source":{"path":"src/core/server/saved_objects/saved_objects_service.ts","lineNumber":202,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L202"},"signature":["() => ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsSerializer","text":"SavedObjectsSerializer"}]},{"id":"def-server.SavedObjectsServiceStart.createExporter","type":"Function","label":"createExporter","description":["\nCreates an {@link ISavedObjectsExporter | exporter} bound to given client."],"source":{"path":"src/core/server/saved_objects/saved_objects_service.ts","lineNumber":206,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L206"},"signature":["(client: Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">) => Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsExporter","text":"SavedObjectsExporter"},", \"exportByTypes\" | \"exportByObjects\">"]},{"id":"def-server.SavedObjectsServiceStart.createImporter","type":"Function","label":"createImporter","description":["\nCreates an {@link ISavedObjectsImporter | importer} bound to given client."],"source":{"path":"src/core/server/saved_objects/saved_objects_service.ts","lineNumber":210,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L210"},"signature":["(client: Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">) => Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImporter","text":"SavedObjectsImporter"},", \"import\" | \"resolveImportErrors\">"]},{"id":"def-server.SavedObjectsServiceStart.getTypeRegistry","type":"Function","label":"getTypeRegistry","description":["\nReturns the {@link ISavedObjectTypeRegistry | registry} containing all registered\n{@link SavedObjectsType | saved object types}"],"source":{"path":"src/core/server/saved_objects/saved_objects_service.ts","lineNumber":215,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L215"},"signature":["() => Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectTypeRegistry","text":"SavedObjectTypeRegistry"},", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">"]}],"source":{"path":"src/core/server/saved_objects/saved_objects_service.ts","lineNumber":162,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L162"},"initialIsOpen":false},{"id":"def-server.SavedObjectsServiceSetup","type":"Interface","label":"SavedObjectsServiceSetup","description":["\nSaved Objects is Kibana's data persistence mechanism allowing plugins to\nuse Elasticsearch for storing and querying state. The SavedObjectsServiceSetup API exposes methods\nfor registering Saved Object types, creating and registering Saved Object client wrappers and factories.\n"],"children":[{"id":"def-server.SavedObjectsServiceSetup.setClientFactoryProvider","type":"Function","label":"setClientFactoryProvider","description":["\nSet the default {@link SavedObjectsClientFactoryProvider | factory provider} for creating Saved Objects clients.\nOnly one provider can be set, subsequent calls to this method will fail."],"source":{"path":"src/core/server/saved_objects/saved_objects_service.ts","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L90"},"signature":["(clientFactoryProvider: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClientFactoryProvider","text":"SavedObjectsClientFactoryProvider"},") => void"]},{"id":"def-server.SavedObjectsServiceSetup.addClientWrapper","type":"Function","label":"addClientWrapper","description":["\nAdd a {@link SavedObjectsClientWrapperFactory | client wrapper factory} with the given priority."],"source":{"path":"src/core/server/saved_objects/saved_objects_service.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L95"},"signature":["(priority: number, id: string, factory: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClientWrapperFactory","text":"SavedObjectsClientWrapperFactory"},") => void"]},{"id":"def-server.SavedObjectsServiceSetup.registerType","type":"Function","label":"registerType","description":["\nRegister a {@link SavedObjectsType | savedObjects type} definition.\n\nSee the {@link SavedObjectsTypeMappingDefinition | mappings format} and\n{@link SavedObjectMigrationMap | migration format} for more details about these.\n"],"source":{"path":"src/core/server/saved_objects/saved_objects_service.ts","lineNumber":144,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L144"},"signature":["(type: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsType","text":"SavedObjectsType"},") => void"]}],"source":{"path":"src/core/server/saved_objects/saved_objects_service.ts","lineNumber":85,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_service.ts#L85"},"initialIsOpen":false},{"id":"def-server.SavedObjectStatusMeta","type":"Interface","label":"SavedObjectStatusMeta","description":["\nMeta information about the SavedObjectService's status. Available to plugins via {@link CoreSetup.status}.\n"],"children":[{"id":"def-server.SavedObjectStatusMeta.migratedIndices","type":"Object","label":"migratedIndices","description":[],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L50"},"signature":["{ [status: string]: number; skipped: number; migrated: number; }"]}],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L49"},"initialIsOpen":false},{"id":"def-server.SavedObjectsDeleteOptions","type":"Interface","label":"SavedObjectsDeleteOptions","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsDeleteOptions","text":"SavedObjectsDeleteOptions"}," extends ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"}],"description":["\n"],"children":[{"id":"def-server.SavedObjectsDeleteOptions.refresh","type":"CompoundType","label":"refresh","description":["The Elasticsearch Refresh setting for this operation"],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":284,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L284"},"signature":["boolean | \"wait_for\" | undefined"]},{"id":"def-server.SavedObjectsDeleteOptions.force","type":"CompoundType","label":"force","description":["Force deletion of an object that exists in multiple namespaces"],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":286,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L286"},"signature":["boolean | undefined"]}],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":282,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L282"},"initialIsOpen":false},{"id":"def-server.SavedObjectsDeleteByNamespaceOptions","type":"Interface","label":"SavedObjectsDeleteByNamespaceOptions","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsDeleteByNamespaceOptions","text":"SavedObjectsDeleteByNamespaceOptions"}," extends ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"}],"description":["\n"],"children":[{"id":"def-server.SavedObjectsDeleteByNamespaceOptions.refresh","type":"CompoundType","label":"refresh","description":["The Elasticsearch supports only boolean flag for this operation"],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":118,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L118"},"signature":["boolean | undefined"]}],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L116"},"initialIsOpen":false},{"id":"def-server.SavedObjectsIncrementCounterOptions","type":"Interface","label":"SavedObjectsIncrementCounterOptions","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsIncrementCounterOptions","text":"SavedObjectsIncrementCounterOptions"}," extends ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"}],"description":[],"children":[{"id":"def-server.SavedObjectsIncrementCounterOptions.initialize","type":"CompoundType","label":"initialize","description":["\n(default=false) If true, sets all the counter fields to 0 if they don't\nalready exist. Existing fields will be left as-is and won't be incremented."],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L102"},"signature":["boolean | undefined"]},{"id":"def-server.SavedObjectsIncrementCounterOptions.migrationVersion","type":"Object","label":"migrationVersion","description":["{@link SavedObjectsMigrationVersion}"],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L104"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectsMigrationVersion","text":"SavedObjectsMigrationVersion"}," | undefined"]},{"id":"def-server.SavedObjectsIncrementCounterOptions.refresh","type":"CompoundType","label":"refresh","description":["\n(default='wait_for') The Elasticsearch refresh setting for this\noperation. See {@link MutatingOperationRefreshSetting}"],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":109,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L109"},"signature":["boolean | \"wait_for\" | undefined"]}],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L97"},"initialIsOpen":false},{"id":"def-server.SavedObjectsIncrementCounterField","type":"Interface","label":"SavedObjectsIncrementCounterField","description":[],"children":[{"id":"def-server.SavedObjectsIncrementCounterField.fieldName","type":"string","label":"fieldName","description":["The field name to increment the counter by."],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":135,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L135"}},{"id":"def-server.SavedObjectsIncrementCounterField.incrementBy","type":"number","label":"incrementBy","description":["The number to increment the field by (defaults to 1)."],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":137,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L137"},"signature":["number | undefined"]}],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":133,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L133"},"initialIsOpen":false},{"id":"def-server.SavedObjectsComplexFieldMapping","type":"Interface","label":"SavedObjectsComplexFieldMapping","description":["\nSee {@link SavedObjectsFieldMapping} for documentation.\n"],"children":[{"id":"def-server.SavedObjectsComplexFieldMapping.dynamic","type":"CompoundType","label":"dynamic","description":["\nThe dynamic property of the mapping, either `false` or `'strict'`. If\nunspecified `dynamic: 'strict'` will be inherited from the top-level\nindex mappings.\n\nNote: To limit the number of mapping fields Saved Object types should\n*never* use `dynamic: true`."],"source":{"path":"src/core/server/saved_objects/mappings/types.ts","lineNumber":150,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L150"},"signature":["false | \"strict\" | undefined"]},{"id":"def-server.SavedObjectsComplexFieldMapping.enabled","type":"CompoundType","label":"enabled","description":[],"source":{"path":"src/core/server/saved_objects/mappings/types.ts","lineNumber":151,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L151"},"signature":["boolean | undefined"]},{"id":"def-server.SavedObjectsComplexFieldMapping.doc_values","type":"CompoundType","label":"doc_values","description":[],"source":{"path":"src/core/server/saved_objects/mappings/types.ts","lineNumber":152,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L152"},"signature":["boolean | undefined"]},{"id":"def-server.SavedObjectsComplexFieldMapping.type","type":"string","label":"type","description":[],"source":{"path":"src/core/server/saved_objects/mappings/types.ts","lineNumber":153,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L153"},"signature":["string | undefined"]},{"id":"def-server.SavedObjectsComplexFieldMapping.properties","type":"Object","label":"properties","description":[],"source":{"path":"src/core/server/saved_objects/mappings/types.ts","lineNumber":154,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L154"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsMappingProperties","text":"SavedObjectsMappingProperties"}]}],"source":{"path":"src/core/server/saved_objects/mappings/types.ts","lineNumber":141,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L141"},"initialIsOpen":false},{"id":"def-server.SavedObjectsCoreFieldMapping","type":"Interface","label":"SavedObjectsCoreFieldMapping","description":["\nSee {@link SavedObjectsFieldMapping} for documentation.\n"],"children":[{"id":"def-server.SavedObjectsCoreFieldMapping.type","type":"string","label":"type","description":[],"source":{"path":"src/core/server/saved_objects/mappings/types.ts","lineNumber":124,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L124"}},{"id":"def-server.SavedObjectsCoreFieldMapping.null_value","type":"CompoundType","label":"null_value","description":[],"source":{"path":"src/core/server/saved_objects/mappings/types.ts","lineNumber":125,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L125"},"signature":["string | number | boolean | undefined"]},{"id":"def-server.SavedObjectsCoreFieldMapping.index","type":"CompoundType","label":"index","description":[],"source":{"path":"src/core/server/saved_objects/mappings/types.ts","lineNumber":126,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L126"},"signature":["boolean | undefined"]},{"id":"def-server.SavedObjectsCoreFieldMapping.doc_values","type":"CompoundType","label":"doc_values","description":[],"source":{"path":"src/core/server/saved_objects/mappings/types.ts","lineNumber":127,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L127"},"signature":["boolean | undefined"]},{"id":"def-server.SavedObjectsCoreFieldMapping.fields","type":"Object","label":"fields","description":[],"source":{"path":"src/core/server/saved_objects/mappings/types.ts","lineNumber":128,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L128"},"signature":["{ [subfield: string]: { type: string; ignore_above?: number | undefined; }; } | undefined"]}],"source":{"path":"src/core/server/saved_objects/mappings/types.ts","lineNumber":123,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L123"},"initialIsOpen":false},{"id":"def-server.SavedObjectsTypeMappingDefinition","type":"Interface","label":"SavedObjectsTypeMappingDefinition","description":["\nDescribe a saved object type mapping.\n"],"children":[{"id":"def-server.SavedObjectsTypeMappingDefinition.dynamic","type":"CompoundType","label":"dynamic","description":["The dynamic property of the mapping, either `false` or `'strict'`. If\nunspecified `dynamic: 'strict'` will be inherited from the top-level\nindex mappings."],"source":{"path":"src/core/server/saved_objects/mappings/types.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L40"},"signature":["false | \"strict\" | undefined"]},{"id":"def-server.SavedObjectsTypeMappingDefinition.properties","type":"Object","label":"properties","description":["The underlying properties of the type mapping"],"source":{"path":"src/core/server/saved_objects/mappings/types.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L42"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsMappingProperties","text":"SavedObjectsMappingProperties"}]}],"source":{"path":"src/core/server/saved_objects/mappings/types.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L36"},"initialIsOpen":false},{"id":"def-server.SavedObjectsMappingProperties","type":"Interface","label":"SavedObjectsMappingProperties","description":["\nDescribe the fields of a {@link SavedObjectsTypeMappingDefinition | saved object type}.\n"],"children":[{"id":"def-server.SavedObjectsMappingProperties.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/saved_objects/mappings/types.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L88"},"signature":["any"]}],"source":{"path":"src/core/server/saved_objects/mappings/types.ts","lineNumber":87,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L87"},"initialIsOpen":false},{"id":"def-server.SavedObjectsType","type":"Interface","label":"SavedObjectsType","description":[],"children":[{"id":"def-server.SavedObjectsType.name","type":"string","label":"name","description":["\nThe name of the type, which is also used as the internal id."],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":237,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L237"}},{"id":"def-server.SavedObjectsType.hidden","type":"boolean","label":"hidden","description":["\nIs the type hidden by default. If true, repositories will not have access to this type unless explicitly\ndeclared as an `extraType` when creating the repository.\n\nSee {@link SavedObjectsServiceStart.createInternalRepository | createInternalRepository}."],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":244,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L244"}},{"id":"def-server.SavedObjectsType.namespaceType","type":"CompoundType","label":"namespaceType","description":["\nThe {@link SavedObjectsNamespaceType | namespace type} for the type."],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":248,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L248"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsNamespaceType","text":"SavedObjectsNamespaceType"}]},{"id":"def-server.SavedObjectsType.indexPattern","type":"string","label":"indexPattern","description":["\nIf defined, the type instances will be stored in the given index instead of the default one."],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":252,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L252"},"signature":["string | undefined"]},{"id":"def-server.SavedObjectsType.convertToAliasScript","type":"string","label":"convertToAliasScript","description":["\nIf defined, will be used to convert the type to an alias."],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":256,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L256"},"signature":["string | undefined"]},{"id":"def-server.SavedObjectsType.mappings","type":"Object","label":"mappings","description":["\nThe {@link SavedObjectsTypeMappingDefinition | mapping definition} for the type."],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":260,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L260"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsTypeMappingDefinition","text":"SavedObjectsTypeMappingDefinition"}]},{"id":"def-server.SavedObjectsType.migrations","type":"CompoundType","label":"migrations","description":["\nAn optional map of {@link SavedObjectMigrationFn | migrations} or a function returning a map of {@link SavedObjectMigrationFn | migrations} to be used to migrate the type."],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":264,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L264"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectMigrationMap","text":"SavedObjectMigrationMap"}," | (() => ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectMigrationMap","text":"SavedObjectMigrationMap"},") | undefined"]},{"id":"def-server.SavedObjectsType.convertToMultiNamespaceTypeVersion","type":"string","label":"convertToMultiNamespaceTypeVersion","description":["\nIf defined, objects of this type will be converted to a 'multiple' or 'multiple-isolated' namespace type when migrating to this\nversion.\n\nRequirements:\n\n 1. This string value must be a valid semver version\n 2. This type must have previously specified {@link SavedObjectsNamespaceType | `namespaceType: 'single'`}\n 3. This type must also specify {@link SavedObjectsNamespaceType | `namespaceType: 'multiple'`} *or*\n {@link SavedObjectsNamespaceType | `namespaceType: 'multiple-isolated'`}\n\nExample of a single-namespace type in 7.12:\n\n```ts\n{\n name: 'foo',\n hidden: false,\n namespaceType: 'single',\n mappings: {...}\n}\n```\n\nExample after converting to a multi-namespace (isolated) type in 8.0:\n\n```ts\n{\n name: 'foo',\n hidden: false,\n namespaceType: 'multiple-isolated',\n mappings: {...},\n convertToMultiNamespaceTypeVersion: '8.0.0'\n}\n```\n\nExample after converting to a multi-namespace (shareable) type in 8.1:\n\n```ts\n{\n name: 'foo',\n hidden: false,\n namespaceType: 'multiple',\n mappings: {...},\n convertToMultiNamespaceTypeVersion: '8.0.0'\n}\n```\n\nNote: migration function(s) can be optionally specified for any of these versions and will not interfere with the conversion process."],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":313,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L313"},"signature":["string | undefined"]},{"id":"def-server.SavedObjectsType.management","type":"Object","label":"management","description":["\nAn optional {@link SavedObjectsTypeManagementDefinition | saved objects management section} definition for the type."],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":317,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L317"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsTypeManagementDefinition","text":"SavedObjectsTypeManagementDefinition"}," | undefined"]}],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":233,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L233"},"initialIsOpen":false},{"id":"def-server.SavedObjectsTypeManagementDefinition","type":"Interface","label":"SavedObjectsTypeManagementDefinition","description":["\nConfiguration options for the {@link SavedObjectsType | type}'s management section.\n"],"children":[{"id":"def-server.SavedObjectsTypeManagementDefinition.importableAndExportable","type":"CompoundType","label":"importableAndExportable","description":["\nIs the type importable or exportable. Defaults to `false`."],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":329,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L329"},"signature":["boolean | undefined"]},{"id":"def-server.SavedObjectsTypeManagementDefinition.defaultSearchField","type":"string","label":"defaultSearchField","description":["\nThe default search field to use for this type. Defaults to `id`."],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":333,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L333"},"signature":["string | undefined"]},{"id":"def-server.SavedObjectsTypeManagementDefinition.icon","type":"string","label":"icon","description":["\nThe eui icon name to display in the management table.\nIf not defined, the default icon will be used."],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":338,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L338"},"signature":["string | undefined"]},{"id":"def-server.SavedObjectsTypeManagementDefinition.getTitle","type":"Function","label":"getTitle","description":["\nFunction returning the title to display in the management table.\nIf not defined, will use the object's type and id to generate a label."],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":343,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L343"},"signature":["((savedObject: ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},") => string) | undefined"]},{"id":"def-server.SavedObjectsTypeManagementDefinition.getEditUrl","type":"Function","label":"getEditUrl","description":["\nFunction returning the url to use to redirect to the editing page of this object.\nIf not defined, editing will not be allowed."],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":348,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L348"},"signature":["((savedObject: ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},") => string) | undefined"]},{"id":"def-server.SavedObjectsTypeManagementDefinition.getInAppUrl","type":"Function","label":"getInAppUrl","description":["\nFunction returning the url to use to redirect to this object from the management section.\nIf not defined, redirecting to the object will not be allowed.\n"],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":357,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L357"},"signature":["((savedObject: ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},") => { path: string; uiCapabilitiesPath: string; }) | undefined"]},{"id":"def-server.SavedObjectsTypeManagementDefinition.onExport","type":"Function","label":"onExport","description":["\nAn optional export transform function that can be used transform the objects of the registered type during\nthe export process.\n\nIt can be used to either mutate the exported objects, or add additional objects (of any type) to the export list.\n\nSee {@link SavedObjectsExportTransform | the transform type documentation} for more info and examples.\n"],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":368,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L368"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsExportTransform","text":"SavedObjectsExportTransform"}," | undefined"]},{"id":"def-server.SavedObjectsTypeManagementDefinition.onImport","type":"Function","label":"onImport","description":["\nAn optional {@link SavedObjectsImportHook | import hook} to use when importing given type.\n\nImport hooks are executed during the savedObjects import process and allow to interact\nwith the imported objects. See the {@link SavedObjectsImportHook | hook documentation}\nfor more info.\n"],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":411,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L411"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportHook","text":"SavedObjectsImportHook"}," | undefined"]}],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":325,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L325"},"initialIsOpen":false},{"id":"def-server.SavedObjectMigrationMap","type":"Interface","label":"SavedObjectMigrationMap","description":["\nA map of {@link SavedObjectMigrationFn | migration functions} to be used for a given type.\nThe map's keys must be valid semver versions, and they cannot exceed the current Kibana version.\n\nFor a given document, only migrations with a higher version number than that of the document will be applied.\nMigrations are executed in order, starting from the lowest version and ending with the highest one.\n"],"children":[{"id":"def-server.SavedObjectMigrationMap.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/core/server/saved_objects/migrations/types.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/types.ts#L88"},"signature":["any"]}],"source":{"path":"src/core/server/saved_objects/migrations/types.ts","lineNumber":87,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/types.ts#L87"},"initialIsOpen":false},{"id":"def-server.SavedObjectExportBaseOptions","type":"Interface","label":"SavedObjectExportBaseOptions","description":[],"children":[{"id":"def-server.SavedObjectExportBaseOptions.request","type":"Object","label":"request","description":["The http request initiating the export."],"source":{"path":"src/core/server/saved_objects/export/types.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L15"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},""]},{"id":"def-server.SavedObjectExportBaseOptions.includeReferencesDeep","type":"CompoundType","label":"includeReferencesDeep","description":["flag to also include all related saved objects in the export stream."],"source":{"path":"src/core/server/saved_objects/export/types.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L17"},"signature":["boolean | undefined"]},{"id":"def-server.SavedObjectExportBaseOptions.excludeExportDetails","type":"CompoundType","label":"excludeExportDetails","description":["flag to not append {@link SavedObjectsExportResultDetails | export details} to the end of the export stream."],"source":{"path":"src/core/server/saved_objects/export/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L19"},"signature":["boolean | undefined"]},{"id":"def-server.SavedObjectExportBaseOptions.namespace","type":"string","label":"namespace","description":["optional namespace to override the namespace used by the savedObjectsClient."],"source":{"path":"src/core/server/saved_objects/export/types.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L21"},"signature":["string | undefined"]}],"source":{"path":"src/core/server/saved_objects/export/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L13"},"initialIsOpen":false},{"id":"def-server.SavedObjectsExportByObjectOptions","type":"Interface","label":"SavedObjectsExportByObjectOptions","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsExportByObjectOptions","text":"SavedObjectsExportByObjectOptions"}," extends ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectExportBaseOptions","text":"SavedObjectExportBaseOptions"}],"description":["\nOptions for the {@link SavedObjectsExporter.exportByObjects | export by objects API}\n"],"children":[{"id":"def-server.SavedObjectsExportByObjectOptions.objects","type":"Array","label":"objects","description":["optional array of objects to export."],"source":{"path":"src/core/server/saved_objects/export/types.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L45"},"signature":["{ id: string; type: string; }[]"]}],"source":{"path":"src/core/server/saved_objects/export/types.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L43"},"initialIsOpen":false},{"id":"def-server.SavedObjectsExportByTypeOptions","type":"Interface","label":"SavedObjectsExportByTypeOptions","signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsExportByTypeOptions","text":"SavedObjectsExportByTypeOptions"}," extends ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectExportBaseOptions","text":"SavedObjectExportBaseOptions"}],"description":["\nOptions for the {@link SavedObjectsExporter.exportByTypes | export by type API}\n"],"children":[{"id":"def-server.SavedObjectsExportByTypeOptions.types","type":"Array","label":"types","description":["array of saved object types."],"source":{"path":"src/core/server/saved_objects/export/types.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L31"},"signature":["string[]"]},{"id":"def-server.SavedObjectsExportByTypeOptions.hasReference","type":"Array","label":"hasReference","description":["optional array of references to search object for."],"source":{"path":"src/core/server/saved_objects/export/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L33"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsFindOptionsReference","text":"SavedObjectsFindOptionsReference"},"[] | undefined"]},{"id":"def-server.SavedObjectsExportByTypeOptions.search","type":"string","label":"search","description":["optional query string to filter exported objects."],"source":{"path":"src/core/server/saved_objects/export/types.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L35"},"signature":["string | undefined"]}],"source":{"path":"src/core/server/saved_objects/export/types.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L29"},"initialIsOpen":false},{"id":"def-server.SavedObjectsExportTransformContext","type":"Interface","label":"SavedObjectsExportTransformContext","description":["\nContext passed down to a {@link SavedObjectsExportTransform | export transform function}\n"],"children":[{"id":"def-server.SavedObjectsExportTransformContext.request","type":"Object","label":"request","description":["\nThe request that initiated the export request. Can be used to create scoped\nservices or client inside the {@link SavedObjectsExportTransform | transformation}"],"source":{"path":"src/core/server/saved_objects/export/types.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L81"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},""]}],"source":{"path":"src/core/server/saved_objects/export/types.ts","lineNumber":76,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L76"},"initialIsOpen":false},{"id":"def-server.SavedObjectsImportHookResult","type":"Interface","label":"SavedObjectsImportHookResult","description":["\nResult from a {@link SavedObjectsImportHook | import hook}\n"],"children":[{"id":"def-server.SavedObjectsImportHookResult.warnings","type":"Array","label":"warnings","description":["\nAn optional list of warnings to display in the UI when the import succeeds."],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":231,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L231"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportWarning","text":"SavedObjectsImportWarning"},"[] | undefined"]}],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":227,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L227"},"initialIsOpen":false},{"id":"def-server.SavedObjectsImportSimpleWarning","type":"Interface","label":"SavedObjectsImportSimpleWarning","description":["\nA simple informative warning that will be displayed to the user.\n"],"children":[{"id":"def-server.SavedObjectsImportSimpleWarning.type","type":"string","label":"type","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":187,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L187"},"signature":["\"simple\""]},{"id":"def-server.SavedObjectsImportSimpleWarning.message","type":"string","label":"message","description":["The translated message to display to the user"],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":189,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L189"}}],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":186,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L186"},"initialIsOpen":false},{"id":"def-server.SavedObjectsImportActionRequiredWarning","type":"Interface","label":"SavedObjectsImportActionRequiredWarning","description":["\nA warning meant to notify that a specific user action is required to finalize the import\nof some type of object.\n"],"children":[{"id":"def-server.SavedObjectsImportActionRequiredWarning.type","type":"string","label":"type","description":[],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":201,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L201"},"signature":["\"action_required\""]},{"id":"def-server.SavedObjectsImportActionRequiredWarning.message","type":"string","label":"message","description":["The translated message to display to the user."],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":203,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L203"}},{"id":"def-server.SavedObjectsImportActionRequiredWarning.actionPath","type":"string","label":"actionPath","description":["The path (without the basePath) that the user should be redirect to to address this warning."],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":205,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L205"}},{"id":"def-server.SavedObjectsImportActionRequiredWarning.buttonLabel","type":"string","label":"buttonLabel","description":["An optional label to use for the link button. If unspecified, a default label will be used."],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":207,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L207"},"signature":["string | undefined"]}],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":200,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L200"},"initialIsOpen":false},{"id":"def-server.SavedObjectsBaseOptions","type":"Interface","label":"SavedObjectsBaseOptions","description":["\n"],"children":[{"id":"def-server.SavedObjectsBaseOptions.namespace","type":"string","label":"namespace","description":["Specify the namespace for this operation"],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":141,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L141"},"signature":["string | undefined"]}],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":139,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L139"},"initialIsOpen":false},{"id":"def-server.SavedObjectsFindOptions","type":"Interface","label":"SavedObjectsFindOptions","description":["\n"],"children":[{"id":"def-server.SavedObjectsFindOptions.type","type":"CompoundType","label":"type","description":[],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L78"},"signature":["string | string[]"]},{"id":"def-server.SavedObjectsFindOptions.page","type":"number","label":"page","description":[],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L79"},"signature":["number | undefined"]},{"id":"def-server.SavedObjectsFindOptions.perPage","type":"number","label":"perPage","description":[],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L80"},"signature":["number | undefined"]},{"id":"def-server.SavedObjectsFindOptions.sortField","type":"string","label":"sortField","description":[],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L81"},"signature":["string | undefined"]},{"id":"def-server.SavedObjectsFindOptions.sortOrder","type":"string","label":"sortOrder","description":[],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L82"},"signature":["string | undefined"]},{"id":"def-server.SavedObjectsFindOptions.fields","type":"Array","label":"fields","description":["\nAn array of fields to include in the results"],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L88"},"signature":["string[] | undefined"]},{"id":"def-server.SavedObjectsFindOptions.search","type":"string","label":"search","description":["Search documents using the Elasticsearch Simple Query String syntax. See Elasticsearch Simple Query String `query` argument for more information"],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L90"},"signature":["string | undefined"]},{"id":"def-server.SavedObjectsFindOptions.searchFields","type":"Array","label":"searchFields","description":["The fields to perform the parsed query against. See Elasticsearch Simple Query String `fields` argument for more information"],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L92"},"signature":["string[] | undefined"]},{"id":"def-server.SavedObjectsFindOptions.searchAfter","type":"Array","label":"searchAfter","description":["\nUse the sort values from the previous page to retrieve the next page of results."],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L96"},"signature":["unknown[] | undefined"]},{"id":"def-server.SavedObjectsFindOptions.rootSearchFields","type":"Array","label":"rootSearchFields","description":["\nThe fields to perform the parsed query against. Unlike the `searchFields` argument, these are expected to be root fields and will not\nbe modified. If used in conjunction with `searchFields`, both are concatenated together."],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L101"},"signature":["string[] | undefined"]},{"id":"def-server.SavedObjectsFindOptions.hasReference","type":"CompoundType","label":"hasReference","description":["\nSearch for documents having a reference to the specified objects.\nUse `hasReferenceOperator` to specify the operator to use when searching for multiple references."],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":107,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L107"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsFindOptionsReference","text":"SavedObjectsFindOptionsReference"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsFindOptionsReference","text":"SavedObjectsFindOptionsReference"},"[] | undefined"]},{"id":"def-server.SavedObjectsFindOptions.hasReferenceOperator","type":"CompoundType","label":"hasReferenceOperator","description":["\nThe operator to use when searching by multiple references using the `hasReference` option. Defaults to `OR`"],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":111,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L111"},"signature":["\"AND\" | \"OR\" | undefined"]},{"id":"def-server.SavedObjectsFindOptions.defaultSearchOperator","type":"CompoundType","label":"defaultSearchOperator","description":["\nThe search operator to use with the provided filter. Defaults to `OR`"],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L116"},"signature":["\"AND\" | \"OR\" | undefined"]},{"id":"def-server.SavedObjectsFindOptions.filter","type":"Any","label":"filter","description":[],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":117,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L117"},"signature":["any"]},{"id":"def-server.SavedObjectsFindOptions.namespaces","type":"Array","label":"namespaces","description":[],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":118,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L118"},"signature":["string[] | undefined"]},{"id":"def-server.SavedObjectsFindOptions.typeToNamespacesMap","type":"Object","label":"typeToNamespacesMap","description":["\nThis map defines each type to search for, and the namespace(s) to search for the type in; this is only intended to be used by a saved\nobject client wrapper.\nIf this is defined, it supersedes the `type` and `namespaces` fields when building the Elasticsearch query.\nAny types that are not included in this map will be excluded entirely.\nIf a type is included but its value is undefined, the operation will search for that type in the Default namespace."],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":126,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L126"},"signature":["Map | undefined"]},{"id":"def-server.SavedObjectsFindOptions.preference","type":"string","label":"preference","description":["An optional ES preference value to be used for the query"],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":128,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L128"},"signature":["string | undefined"]},{"id":"def-server.SavedObjectsFindOptions.pit","type":"Object","label":"pit","description":["\nSearch against a specific Point In Time (PIT) that you've opened with {@link SavedObjectsClient.openPointInTimeForType}."],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":132,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L132"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsPitParams","text":"SavedObjectsPitParams"}," | undefined"]}],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L77"},"initialIsOpen":false},{"id":"def-server.SavedObjectsFindOptionsReference","type":"Interface","label":"SavedObjectsFindOptionsReference","description":[],"children":[{"id":"def-server.SavedObjectsFindOptionsReference.type","type":"string","label":"type","description":[],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L61"}},{"id":"def-server.SavedObjectsFindOptionsReference.id","type":"string","label":"id","description":[],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L62"}}],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L60"},"initialIsOpen":false},{"id":"def-server.SavedObjectsPitParams","type":"Interface","label":"SavedObjectsPitParams","description":[],"children":[{"id":"def-server.SavedObjectsPitParams.id","type":"string","label":"id","description":[],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L69"}},{"id":"def-server.SavedObjectsPitParams.keepAlive","type":"string","label":"keepAlive","description":[],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L70"},"signature":["string | undefined"]}],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L68"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-server.SavedObjectsClientWrapperFactory","type":"Type","label":"SavedObjectsClientWrapperFactory","description":["\nDescribes the factory used to create instances of Saved Objects Client Wrappers."],"source":{"path":"src/core/server/saved_objects/service/lib/scoped_client_provider.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/scoped_client_provider.ts#L29"},"signature":["(options: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClientWrapperOptions","text":"SavedObjectsClientWrapperOptions"},") => Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">"],"initialIsOpen":false},{"id":"def-server.SavedObjectsClientFactory","type":"Type","label":"SavedObjectsClientFactory","description":["\nDescribes the factory used to create instances of the Saved Objects Client."],"source":{"path":"src/core/server/saved_objects/service/lib/scoped_client_provider.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/scoped_client_provider.ts#L37"},"signature":["(__0: { request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},"; includedHiddenTypes?: string[] | undefined; }) => Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">"],"initialIsOpen":false},{"id":"def-server.SavedObjectsClientFactoryProvider","type":"Type","label":"SavedObjectsClientFactoryProvider","description":["\nProvider to invoke to retrieve a {@link SavedObjectsClientFactory}."],"source":{"path":"src/core/server/saved_objects/service/lib/scoped_client_provider.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/scoped_client_provider.ts#L49"},"signature":["(repositoryFactory: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsRepositoryFactory","text":"SavedObjectsRepositoryFactory"},") => ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClientFactory","text":"SavedObjectsClientFactory"}],"initialIsOpen":false},{"id":"def-server.SavedObjectsClosePointInTimeOptions","type":"Type","label":"SavedObjectsClosePointInTimeOptions","description":[],"source":{"path":"src/core/server/saved_objects/service/saved_objects_client.ts","lineNumber":375,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/saved_objects_client.ts#L375"},"signature":["SavedObjectsBaseOptions"],"initialIsOpen":false},{"id":"def-server.SavedObjectSanitizedDoc","type":"Type","label":"SavedObjectSanitizedDoc","description":["\nDescribes Saved Object documents that have passed through the migration\nframework and are guaranteed to have a `references` root property.\n"],"source":{"path":"src/core/server/saved_objects/serialization/types.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L71"},"signature":["SavedObjectDoc & Referencable"],"initialIsOpen":false},{"id":"def-server.SavedObjectUnsanitizedDoc","type":"Type","label":"SavedObjectUnsanitizedDoc","description":["\nDescribes Saved Object documents from Kibana < 7.0.0 which don't have a\n`references` root property defined. This type should only be used in\nmigrations.\n"],"source":{"path":"src/core/server/saved_objects/serialization/types.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/serialization/types.ts#L63"},"signature":["SavedObjectDoc & Partial"],"initialIsOpen":false},{"id":"def-server.ISavedObjectsRepository","type":"Type","label":"ISavedObjectsRepository","description":["\nSee {@link SavedObjectsRepository}\n"],"source":{"path":"src/core/server/saved_objects/service/lib/repository.ts","lineNumber":128,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/service/lib/repository.ts#L128"},"signature":["{ get: (type: string, id: string, options?: SavedObjectsBaseOptions) => Promise>; delete: (type: string, id: string, options?: SavedObjectsDeleteOptions) => Promise<{}>; create: (type: string, attributes: T, options?: SavedObjectsCreateOptions) => Promise>; find: (options: SavedObjectsFindOptions) => Promise>; update: (type: string, id: string, attributes: Partial, options?: SavedObjectsUpdateOptions) => Promise>; bulkCreate: (objects: SavedObjectsBulkCreateObject[], options?: SavedObjectsCreateOptions) => Promise>; bulkGet: (objects?: SavedObjectsBulkGetObject[], options?: SavedObjectsBaseOptions) => Promise>; bulkUpdate: (objects: SavedObjectsBulkUpdateObject[], options?: SavedObjectsBulkUpdateOptions) => Promise>; checkConflicts: (objects?: SavedObjectsCheckConflictsObject[], options?: SavedObjectsBaseOptions) => Promise; resolve: (type: string, id: string, options?: SavedObjectsBaseOptions) => Promise>; addToNamespaces: (type: string, id: string, namespaces: string[], options?: SavedObjectsAddToNamespacesOptions) => Promise; deleteFromNamespaces: (type: string, id: string, namespaces: string[], options?: SavedObjectsDeleteFromNamespacesOptions) => Promise; removeReferencesTo: (type: string, id: string, options?: SavedObjectsRemoveReferencesToOptions) => Promise; openPointInTimeForType: (type: string | string[], { keepAlive, preference }?: SavedObjectsOpenPointInTimeOptions) => Promise; closePointInTime: (id: string, options?: SavedObjectsBaseOptions | undefined) => Promise; deleteByNamespace: (namespace: string, options?: SavedObjectsDeleteByNamespaceOptions) => Promise; incrementCounter: (type: string, id: string, counterFields: (string | SavedObjectsIncrementCounterField)[], options?: SavedObjectsIncrementCounterOptions) => Promise>; }"],"initialIsOpen":false},{"id":"def-server.SavedObjectsFieldMapping","type":"Type","label":"SavedObjectsFieldMapping","description":["\nDescribe a {@link SavedObjectsTypeMappingDefinition | saved object type mapping} field.\n\nPlease refer to {@link https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-types.html | elasticsearch documentation}\nFor the mapping documentation\n"],"source":{"path":"src/core/server/saved_objects/mappings/types.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/mappings/types.ts#L99"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsComplexFieldMapping","text":"SavedObjectsComplexFieldMapping"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsCoreFieldMapping","text":"SavedObjectsCoreFieldMapping"}],"initialIsOpen":false},{"id":"def-server.ISavedObjectTypeRegistry","type":"Type","label":"ISavedObjectTypeRegistry","description":["\nSee {@link SavedObjectTypeRegistry} for documentation.\n"],"source":{"path":"src/core/server/saved_objects/saved_objects_type_registry.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/saved_objects_type_registry.ts#L17"},"signature":["{ getType: (type: string) => SavedObjectsType | undefined; getVisibleTypes: () => SavedObjectsType[]; getAllTypes: () => SavedObjectsType[]; getImportableAndExportableTypes: () => SavedObjectsType[]; isNamespaceAgnostic: (type: string) => boolean; isSingleNamespace: (type: string) => boolean; isMultiNamespace: (type: string) => boolean; isShareable: (type: string) => boolean; isHidden: (type: string) => boolean; getIndex: (type: string) => string | undefined; isImportableAndExportable: (type: string) => boolean; }"],"initialIsOpen":false},{"id":"def-server.SavedObjectsNamespaceType","type":"Type","label":"SavedObjectsNamespaceType","description":["\nThe namespace type dictates how a saved object can be interacted in relation to namespaces. Each type is mutually exclusive:\n * single (default): This type of saved object is namespace-isolated, e.g., it exists in only one namespace.\n * multiple: This type of saved object is shareable, e.g., it can exist in one or more namespaces.\n * multiple-isolated: This type of saved object is namespace-isolated, e.g., it exists in only one namespace, but object IDs must be\n unique across all namespaces. This is intended to be an intermediate step when objects with a \"single\" namespace type are being\n converted to a \"multiple\" namespace type. In other words, objects with a \"multiple-isolated\" namespace type will be *share-capable*,\n but will not actually be shareable until the namespace type is changed to \"multiple\".\n * agnostic: This type of saved object is global.\n"],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":226,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L226"},"signature":["\"multiple\" | \"single\" | \"multiple-isolated\" | \"agnostic\""],"initialIsOpen":false},{"id":"def-server.SavedObjectMigrationFn","type":"Type","label":"SavedObjectMigrationFn","description":["\nA migration function for a {@link SavedObjectsType | saved object type}\nused to migrate it to a given version\n"],"source":{"path":"src/core/server/saved_objects/migrations/types.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/migrations/types.ts#L45"},"signature":["(doc: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectUnsanitizedDoc","text":"SavedObjectUnsanitizedDoc"},", context: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectMigrationContext","text":"SavedObjectMigrationContext"},") => ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectUnsanitizedDoc","text":"SavedObjectUnsanitizedDoc"},""],"initialIsOpen":false},{"id":"def-server.ISavedObjectsExporter","type":"Type","label":"ISavedObjectsExporter","description":[],"source":{"path":"src/core/server/saved_objects/export/saved_objects_exporter.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/saved_objects_exporter.ts#L32"},"signature":["{ exportByTypes: (options: SavedObjectsExportByTypeOptions) => Promise<","Readable",">; exportByObjects: (options: SavedObjectsExportByObjectOptions) => Promise<","Readable",">; }"],"initialIsOpen":false},{"id":"def-server.SavedObjectsExportTransform","type":"Type","label":"SavedObjectsExportTransform","description":["\nTransformation function used to mutate the exported objects of the associated type.\n\nA type's export transform function will be executed once per user-initiated export,\nfor all objects of that type.\n"],"source":{"path":"src/core/server/saved_objects/export/types.ts","lineNumber":155,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/export/types.ts#L155"},"signature":["(context: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsExportTransformContext","text":"SavedObjectsExportTransformContext"},", objects: ","SavedObject","[]) => ","SavedObject","[] | Promise<","SavedObject","[]>"],"initialIsOpen":false},{"id":"def-server.ISavedObjectsImporter","type":"Type","label":"ISavedObjectsImporter","description":[],"source":{"path":"src/core/server/saved_objects/import/saved_objects_importer.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/saved_objects_importer.ts#L24"},"signature":["{ import: ({ readStream, createNewCopies, namespace, overwrite, }: SavedObjectsImportOptions) => Promise; resolveImportErrors: ({ readStream, createNewCopies, namespace, retries, }: SavedObjectsResolveImportErrorsOptions) => Promise; }"],"initialIsOpen":false},{"id":"def-server.SavedObjectsImportHook","type":"Type","label":"SavedObjectsImportHook","description":["\nA hook associated with a specific saved object type, that will be invoked during\nthe import process. The hook will have access to the objects of the registered type.\n\nCurrently, the only supported feature for import hooks is to return warnings to be displayed\nin the UI when the import succeeds.\n"],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":246,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L246"},"signature":["(objects: ","SavedObject","[]) => ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportHookResult","text":"SavedObjectsImportHookResult"}," | Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportHookResult","text":"SavedObjectsImportHookResult"},">"],"initialIsOpen":false},{"id":"def-server.SavedObjectsImportWarning","type":"Type","label":"SavedObjectsImportWarning","description":["\nComposite type of all the possible types of import warnings.\n\nSee {@link SavedObjectsImportSimpleWarning} and {@link SavedObjectsImportActionRequiredWarning}\nfor more details.\n"],"source":{"path":"src/core/server/saved_objects/import/types.ts","lineNumber":218,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/import/types.ts#L218"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportSimpleWarning","text":"SavedObjectsImportSimpleWarning"}," | ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsImportActionRequiredWarning","text":"SavedObjectsImportActionRequiredWarning"}],"initialIsOpen":false},{"id":"def-server.MutatingOperationRefreshSetting","type":"Type","label":"MutatingOperationRefreshSetting","description":["\nElasticsearch Refresh setting for mutating operation"],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":148,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L148"},"signature":["false | true | \"wait_for\""],"initialIsOpen":false},{"id":"def-server.SavedObjectsClientContract","type":"Type","label":"SavedObjectsClientContract","description":["\nSaved Objects is Kibana's data persisentence mechanism allowing plugins to\nuse Elasticsearch for storing plugin state.\n\n## SavedObjectsClient errors\n\nSince the SavedObjectsClient has its hands in everything we\nare a little paranoid about the way we present errors back to\nto application code. Ideally, all errors will be either:\n\n 1. Caused by bad implementation (ie. undefined is not a function) and\n as such unpredictable\n 2. An error that has been classified and decorated appropriately\n by the decorators in {@link SavedObjectsErrorHelpers}\n\nType 1 errors are inevitable, but since all expected/handle-able errors\nshould be Type 2 the `isXYZError()` helpers exposed at\n`SavedObjectsErrorHelpers` should be used to understand and manage error\nresponses from the `SavedObjectsClient`.\n\nType 2 errors are decorated versions of the source error, so if\nthe elasticsearch client threw an error it will be decorated based\non its type. That means that rather than looking for `error.body.error.type` or\ndoing substring checks on `error.body.error.reason`, just use the helpers to\nunderstand the meaning of the error:\n\n ```js\n if (SavedObjectsErrorHelpers.isNotFoundError(error)) {\n // handle 404\n }\n\n if (SavedObjectsErrorHelpers.isNotAuthorizedError(error)) {\n // 401 handling should be automatic, but in case you wanted to know\n }\n\n // always rethrow the error unless you handle it\n throw error;\n ```\n\n### 404s from missing index\n\nFrom the perspective of application code and APIs the SavedObjectsClient is\na black box that persists objects. One of the internal details that users have\nno control over is that we use an elasticsearch index for persistance and that\nindex might be missing.\n\nAt the time of writing we are in the process of transitioning away from the\noperating assumption that the SavedObjects index is always available. Part of\nthis transition is handling errors resulting from an index missing. These used\nto trigger a 500 error in most cases, and in others cause 404s with different\nerror messages.\n\nFrom my (Spencer) perspective, a 404 from the SavedObjectsApi is a 404; The\nobject the request/call was targeting could not be found. This is why #14141\ntakes special care to ensure that 404 errors are generic and don't distinguish\nbetween index missing or document missing.\n\nSee {@link SavedObjectsClient}\nSee {@link SavedObjectsErrorHelpers}\n"],"source":{"path":"src/core/server/saved_objects/types.ts","lineNumber":212,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/server/saved_objects/types.ts#L212"},"signature":["{ get: (type: string, id: string, options?: SavedObjectsBaseOptions) => Promise>; delete: (type: string, id: string, options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsDeleteOptions","text":"SavedObjectsDeleteOptions"},") => Promise<{}>; create: (type: string, attributes: T, options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsCreateOptions","text":"SavedObjectsCreateOptions"}," | undefined) => Promise>; find: (options: SavedObjectsFindOptions) => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsFindResponse","text":"SavedObjectsFindResponse"},">; update: (type: string, id: string, attributes: Partial, options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsUpdateOptions","text":"SavedObjectsUpdateOptions"},") => Promise<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsUpdateResponse","text":"SavedObjectsUpdateResponse"}],"initialIsOpen":false}],"objects":[]},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]}} \ No newline at end of file diff --git a/api_docs/core_saved_objects.mdx b/api_docs/core_saved_objects.mdx new file mode 100644 index 0000000000000..1c7d503f98819 --- /dev/null +++ b/api_docs/core_saved_objects.mdx @@ -0,0 +1,28 @@ +--- +id: kibCoreSavedObjectsPluginApi +slug: /kibana-dev-docs/core.savedObjectsPluginApi +title: core.savedObjects +image: https://source.unsplash.com/400x175/?github +summary: API docs for the core.savedObjects plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'core.savedObjects'] +--- + +import coreSavedObjectsObj from './core_saved_objects.json'; + +## Client + +### Classes + +### Interfaces + +### Consts, variables and types + +## Server + +### Classes + +### Interfaces + +### Consts, variables and types + diff --git a/api_docs/dashboard.json b/api_docs/dashboard.json new file mode 100644 index 0000000000000..c9280f1f1600f --- /dev/null +++ b/api_docs/dashboard.json @@ -0,0 +1 @@ +{"id":"dashboard","client":{"classes":[{"id":"def-public.DashboardContainer","type":"Class","label":"DashboardContainer","description":[],"signature":[{"pluginId":"dashboard","scope":"public","docId":"kibDashboardPluginApi","section":"def-public.DashboardContainer","text":"DashboardContainer"}," extends ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.Container","text":"Container"},"<","InheritedChildInput",", ",{"pluginId":"dashboard","scope":"public","docId":"kibDashboardPluginApi","section":"def-public.DashboardContainerInput","text":"DashboardContainerInput"},", ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerOutput","text":"ContainerOutput"}],"children":[{"id":"def-public.DashboardContainer.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L104"},"signature":["\"dashboard\""]},{"id":"def-public.DashboardContainer.switchViewMode","type":"Function","label":"switchViewMode","description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":105,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L105"},"signature":["((newViewMode: ",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.ViewMode","text":"ViewMode"},") => void) | undefined"]},{"id":"def-public.DashboardContainer.getPanelCount","type":"Function","children":[],"signature":["() => number"],"description":[],"label":"getPanelCount","source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":107,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L107"},"returnComment":[]},{"id":"def-public.DashboardContainer.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"initialInput","isRequired":true,"signature":[{"pluginId":"dashboard","scope":"public","docId":"kibDashboardPluginApi","section":"def-public.DashboardContainerInput","text":"DashboardContainerInput"}],"description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":112,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L112"}},{"type":"Object","label":"services","isRequired":true,"signature":[{"pluginId":"dashboard","scope":"public","docId":"kibDashboardPluginApi","section":"def-public.DashboardContainerServices","text":"DashboardContainerServices"}],"description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":113,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L113"}},{"type":"Object","label":"parent","isRequired":false,"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.Container","text":"Container"},"<{}, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerInput","text":"ContainerInput"},"<{}>, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerOutput","text":"ContainerOutput"},"> | undefined"],"description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":114,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L114"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":111,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L111"}},{"id":"def-public.DashboardContainer.createNewPanelState","type":"Function","label":"createNewPanelState","signature":[">(factory: ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableFactory","text":"EmbeddableFactory"},", partial?: Partial) => ",{"pluginId":"dashboard","scope":"common","docId":"kibDashboardPluginApi","section":"def-common.DashboardPanelState","text":"DashboardPanelState"}],"description":[],"children":[{"type":"Object","label":"factory","isRequired":true,"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableFactory","text":"EmbeddableFactory"},""],"description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L131"}},{"type":"Object","label":"partial","isRequired":true,"signature":["Partial"],"description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":132,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L132"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":127,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L127"}},{"id":"def-public.DashboardContainer.showPlaceholderUntil","type":"Function","label":"showPlaceholderUntil","signature":["(newStateComplete: Promise>>, placementMethod?: ",{"pluginId":"dashboard","scope":"public","docId":"kibDashboardPluginApi","section":"def-public.PanelPlacementMethod","text":"PanelPlacementMethod"}," | undefined, placementArgs?: TPlacementMethodArgs | undefined) => void"],"description":[],"children":[{"type":"Object","label":"newStateComplete","isRequired":true,"signature":["Promise>>"],"description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":139,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L139"}},{"type":"Function","label":"placementMethod","isRequired":false,"signature":[{"pluginId":"dashboard","scope":"public","docId":"kibDashboardPluginApi","section":"def-public.PanelPlacementMethod","text":"PanelPlacementMethod"}," | undefined"],"description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":140,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L140"}},{"type":"Uncategorized","label":"placementArgs","isRequired":false,"signature":["TPlacementMethodArgs | undefined"],"description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":141,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L141"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":138,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L138"}},{"id":"def-public.DashboardContainer.replacePanel","type":"Function","label":"replacePanel","signature":["(previousPanelState: ",{"pluginId":"dashboard","scope":"common","docId":"kibDashboardPluginApi","section":"def-common.DashboardPanelState","text":"DashboardPanelState"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"},">, newPanelState: Partial<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.PanelState","text":"PanelState"},"<{ id: string; }>>, generateNewId?: boolean | undefined) => void"],"description":[],"children":[{"type":"Object","label":"previousPanelState","isRequired":true,"signature":[{"pluginId":"dashboard","scope":"common","docId":"kibDashboardPluginApi","section":"def-common.DashboardPanelState","text":"DashboardPanelState"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"},">"],"description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":180,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L180"}},{"type":"Object","label":"newPanelState","isRequired":true,"signature":["Partial<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.PanelState","text":"PanelState"},"<{ id: string; }>>"],"description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":181,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L181"}},{"type":"CompoundType","label":"generateNewId","isRequired":false,"signature":["boolean | undefined"],"description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":182,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L182"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":179,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L179"}},{"id":"def-public.DashboardContainer.addOrUpdateEmbeddable","type":"Function","label":"addOrUpdateEmbeddable","signature":[""],"description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":230,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L230"}},{"type":"string","label":"embeddableId","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":230,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L230"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":226,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L226"}},{"id":"def-public.DashboardContainer.render","type":"Function","label":"render","signature":["(dom: HTMLElement) => void"],"description":[],"children":[{"type":"Object","label":"dom","isRequired":true,"signature":["HTMLElement"],"description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":244,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L244"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":244,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L244"}},{"id":"def-public.DashboardContainer.getInheritedInput","type":"Function","label":"getInheritedInput","signature":["(id: string) => ",{"pluginId":"dashboard","scope":"public","docId":"kibDashboardPluginApi","section":"def-public.InheritedChildInput","text":"InheritedChildInput"}],"description":[],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":255,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L255"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":255,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L255"}}],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L103"},"initialIsOpen":false},{"id":"def-public.DashboardContainerFactoryDefinition","type":"Class","label":"DashboardContainerFactoryDefinition","description":[],"signature":[{"pluginId":"dashboard","scope":"public","docId":"kibDashboardPluginApi","section":"def-public.DashboardContainerFactoryDefinition","text":"DashboardContainerFactoryDefinition"}," implements ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableFactoryDefinition","text":"EmbeddableFactoryDefinition"},"<",{"pluginId":"dashboard","scope":"public","docId":"kibDashboardPluginApi","section":"def-public.DashboardContainerInput","text":"DashboardContainerInput"},", ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerOutput","text":"ContainerOutput"},", ",{"pluginId":"dashboard","scope":"public","docId":"kibDashboardPluginApi","section":"def-public.DashboardContainer","text":"DashboardContainer"}],"children":[{"id":"def-public.DashboardContainerFactoryDefinition.isContainerType","type":"boolean","label":"isContainerType","description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx#L32"},"signature":["true"]},{"id":"def-public.DashboardContainerFactoryDefinition.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx#L33"},"signature":["\"dashboard\""]},{"id":"def-public.DashboardContainerFactoryDefinition.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Function","label":"getStartServices","isRequired":true,"signature":["() => Promise<",{"pluginId":"dashboard","scope":"public","docId":"kibDashboardPluginApi","section":"def-public.DashboardContainerServices","text":"DashboardContainerServices"},">"],"description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx#L35"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx#L35"}},{"id":"def-public.DashboardContainerFactoryDefinition.isEditable","type":"Function","children":[],"signature":["() => Promise"],"description":[],"label":"isEditable","source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx#L37"},"returnComment":[]},{"id":"def-public.DashboardContainerFactoryDefinition.getDisplayName","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"getDisplayName","source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx#L42"},"returnComment":[]},{"id":"def-public.DashboardContainerFactoryDefinition.getDefaultInput","type":"Function","label":"getDefaultInput","signature":["() => Partial<",{"pluginId":"dashboard","scope":"public","docId":"kibDashboardPluginApi","section":"def-public.DashboardContainerInput","text":"DashboardContainerInput"},">"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx#L48"}},{"id":"def-public.DashboardContainerFactoryDefinition.create","type":"Function","children":[{"type":"Object","label":"initialInput","isRequired":true,"signature":[{"pluginId":"dashboard","scope":"public","docId":"kibDashboardPluginApi","section":"def-public.DashboardContainerInput","text":"DashboardContainerInput"}],"description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx#L59"}},{"type":"Object","label":"parent","isRequired":false,"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.Container","text":"Container"},"<{}, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerInput","text":"ContainerInput"},"<{}>, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerOutput","text":"ContainerOutput"},"> | undefined"],"description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx#L60"}}],"signature":["(initialInput: ",{"pluginId":"dashboard","scope":"public","docId":"kibDashboardPluginApi","section":"def-public.DashboardContainerInput","text":"DashboardContainerInput"},", parent?: ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.Container","text":"Container"},"<{}, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerInput","text":"ContainerInput"},"<{}>, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerOutput","text":"ContainerOutput"},"> | undefined) => Promise<",{"pluginId":"dashboard","scope":"public","docId":"kibDashboardPluginApi","section":"def-public.DashboardContainer","text":"DashboardContainer"}],"description":[],"label":"create","source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx#L58"},"returnComment":[]}],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container_factory.tsx#L29"},"initialIsOpen":false}],"functions":[{"id":"def-public.createDashboardEditUrl","type":"Function","label":"createDashboardEditUrl","signature":["(id: string | undefined, editMode: boolean | undefined) => string"],"description":[],"children":[{"type":"string","label":"id","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"src/plugins/dashboard/public/dashboard_constants.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/dashboard_constants.ts#L22"}},{"type":"CompoundType","label":"editMode","isRequired":false,"signature":["boolean | undefined"],"description":[],"source":{"path":"src/plugins/dashboard/public/dashboard_constants.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/dashboard_constants.ts#L22"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/dashboard/public/dashboard_constants.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/dashboard_constants.ts#L22"},"initialIsOpen":false},{"id":"def-public.createDashboardUrlGenerator","type":"Function","children":[{"type":"Function","label":"getStartServices","isRequired":true,"signature":["() => Promise<{ appBasePath: string; useHashedUrl: boolean; savedDashboardLoader: ",{"pluginId":"savedObjects","scope":"public","docId":"kibSavedObjectsPluginApi","section":"def-public.SavedObjectLoader","text":"SavedObjectLoader"},"; }>"],"description":[],"source":{"path":"src/plugins/dashboard/public/url_generator.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/url_generator.ts#L92"}}],"signature":["(getStartServices: () => Promise<{ appBasePath: string; useHashedUrl: boolean; savedDashboardLoader: ",{"pluginId":"savedObjects","scope":"public","docId":"kibSavedObjectsPluginApi","section":"def-public.SavedObjectLoader","text":"SavedObjectLoader"},"; }>) => ",{"pluginId":"share","scope":"public","docId":"kibSharePluginApi","section":"def-public.UrlGeneratorsDefinition","text":"UrlGeneratorsDefinition"},"<\"DASHBOARD_APP_URL_GENERATOR\">"],"description":[],"label":"createDashboardUrlGenerator","source":{"path":"src/plugins/dashboard/public/url_generator.ts","lineNumber":91,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/url_generator.ts#L91"},"returnComment":[],"initialIsOpen":false}],"interfaces":[{"id":"def-public.DashboardContainerInput","type":"Interface","label":"DashboardContainerInput","signature":[{"pluginId":"dashboard","scope":"public","docId":"kibDashboardPluginApi","section":"def-public.DashboardContainerInput","text":"DashboardContainerInput"}," extends ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerInput","text":"ContainerInput"},"<{}>"],"description":[],"children":[{"id":"def-public.DashboardContainerInput.dashboardCapabilities","type":"Object","label":"dashboardCapabilities","description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L43"},"signature":[{"pluginId":"dashboard","scope":"public","docId":"kibDashboardPluginApi","section":"def-public.DashboardCapabilities","text":"DashboardCapabilities"}," | undefined"]},{"id":"def-public.DashboardContainerInput.refreshConfig","type":"Object","label":"refreshConfig","description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L44"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.RefreshInterval","text":"RefreshInterval"}," | undefined"]},{"id":"def-public.DashboardContainerInput.isEmbeddedExternally","type":"CompoundType","label":"isEmbeddedExternally","description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L45"},"signature":["boolean | undefined"]},{"id":"def-public.DashboardContainerInput.isFullScreenMode","type":"boolean","label":"isFullScreenMode","description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L46"}},{"id":"def-public.DashboardContainerInput.expandedPanelId","type":"string","label":"expandedPanelId","description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L47"},"signature":["string | undefined"]},{"id":"def-public.DashboardContainerInput.timeRange","type":"Object","label":"timeRange","description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L48"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"}]},{"id":"def-public.DashboardContainerInput.description","type":"string","label":"description","description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L49"},"signature":["string | undefined"]},{"id":"def-public.DashboardContainerInput.useMargins","type":"boolean","label":"useMargins","description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L50"}},{"id":"def-public.DashboardContainerInput.syncColors","type":"CompoundType","label":"syncColors","description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L51"},"signature":["boolean | undefined"]},{"id":"def-public.DashboardContainerInput.viewMode","type":"Enum","label":"viewMode","description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L52"},"signature":[{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.ViewMode","text":"ViewMode"}]},{"id":"def-public.DashboardContainerInput.filters","type":"Array","label":"filters","description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L53"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]"]},{"id":"def-public.DashboardContainerInput.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L54"}},{"id":"def-public.DashboardContainerInput.query","type":"Object","label":"query","description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L55"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.Query","text":"Query"}]},{"id":"def-public.DashboardContainerInput.panels","type":"Object","label":"panels","description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L56"},"signature":["{ [panelId: string]: ",{"pluginId":"dashboard","scope":"common","docId":"kibDashboardPluginApi","section":"def-common.DashboardPanelState","text":"DashboardPanelState"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"}," & { [k: string]: unknown; }>; }"]}],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_container.tsx","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_container.tsx#L42"},"initialIsOpen":false},{"id":"def-public.DashboardFeatureFlagConfig","type":"Interface","label":"DashboardFeatureFlagConfig","description":[],"children":[{"id":"def-public.DashboardFeatureFlagConfig.allowByValueEmbeddables","type":"boolean","label":"allowByValueEmbeddables","description":[],"source":{"path":"src/plugins/dashboard/public/plugin.tsx","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/plugin.tsx#L89"}}],"source":{"path":"src/plugins/dashboard/public/plugin.tsx","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/plugin.tsx#L88"},"initialIsOpen":false},{"id":"def-public.DashboardUrlGeneratorState","type":"Interface","label":"DashboardUrlGeneratorState","description":[],"children":[{"id":"def-public.DashboardUrlGeneratorState.dashboardId","type":"string","label":"dashboardId","description":["\nIf given, the dashboard saved object with this id will be loaded. If not given,\na new, unsaved dashboard will be loaded up."],"source":{"path":"src/plugins/dashboard/public/url_generator.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/url_generator.ts#L34"},"signature":["string | undefined"]},{"id":"def-public.DashboardUrlGeneratorState.timeRange","type":"Object","label":"timeRange","description":["\nOptionally set the time range in the time picker."],"source":{"path":"src/plugins/dashboard/public/url_generator.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/url_generator.ts#L38"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"}," | undefined"]},{"id":"def-public.DashboardUrlGeneratorState.refreshInterval","type":"Object","label":"refreshInterval","description":["\nOptionally set the refresh interval."],"source":{"path":"src/plugins/dashboard/public/url_generator.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/url_generator.ts#L43"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.RefreshInterval","text":"RefreshInterval"}," | undefined"]},{"id":"def-public.DashboardUrlGeneratorState.filters","type":"Array","label":"filters","description":["\nOptionally apply filers. NOTE: if given and used in conjunction with `dashboardId`, and the\nsaved dashboard has filters saved with it, this will _replace_ those filters."],"source":{"path":"src/plugins/dashboard/public/url_generator.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/url_generator.ts#L49"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[] | undefined"]},{"id":"def-public.DashboardUrlGeneratorState.query","type":"Object","label":"query","description":["\nOptionally set a query. NOTE: if given and used in conjunction with `dashboardId`, and the\nsaved dashboard has a query saved with it, this will _replace_ that query."],"source":{"path":"src/plugins/dashboard/public/url_generator.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/url_generator.ts#L54"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.Query","text":"Query"}," | undefined"]},{"id":"def-public.DashboardUrlGeneratorState.useHash","type":"CompoundType","label":"useHash","description":["\nIf not given, will use the uiSettings configuration for `storeInSessionStorage`. useHash determines\nwhether to hash the data in the url to avoid url length issues."],"source":{"path":"src/plugins/dashboard/public/url_generator.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/url_generator.ts#L59"},"signature":["boolean | undefined"]},{"id":"def-public.DashboardUrlGeneratorState.preserveSavedFilters","type":"CompoundType","label":"preserveSavedFilters","description":["\nWhen `true` filters from saved filters from destination dashboard as merged with applied filters\nWhen `false` applied filters take precedence and override saved filters\n\ntrue is default"],"source":{"path":"src/plugins/dashboard/public/url_generator.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/url_generator.ts#L67"},"signature":["boolean | undefined"]},{"id":"def-public.DashboardUrlGeneratorState.viewMode","type":"CompoundType","label":"viewMode","description":["\nView mode of the dashboard."],"source":{"path":"src/plugins/dashboard/public/url_generator.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/url_generator.ts#L72"},"signature":[{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.ViewMode","text":"ViewMode"}," | undefined"]},{"id":"def-public.DashboardUrlGeneratorState.searchSessionId","type":"string","label":"searchSessionId","description":["\nSearch search session ID to restore.\n(Background search)"],"source":{"path":"src/plugins/dashboard/public/url_generator.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/url_generator.ts#L78"},"signature":["string | undefined"]},{"id":"def-public.DashboardUrlGeneratorState.panels","type":"Array","label":"panels","description":["\nList of dashboard panels"],"source":{"path":"src/plugins/dashboard/public/url_generator.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/url_generator.ts#L83"},"signature":[{"pluginId":"dashboard","scope":"common","docId":"kibDashboardPluginApi","section":"def-common.SavedDashboardPanel730ToLatest","text":"SavedDashboardPanel730ToLatest"},"[] | undefined"]},{"id":"def-public.DashboardUrlGeneratorState.savedQuery","type":"string","label":"savedQuery","description":["\nSaved query ID"],"source":{"path":"src/plugins/dashboard/public/url_generator.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/url_generator.ts#L88"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/dashboard/public/url_generator.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/url_generator.ts#L29"},"initialIsOpen":false},{"id":"def-public.DashboardSavedObject","type":"Interface","label":"DashboardSavedObject","signature":[{"pluginId":"dashboard","scope":"public","docId":"kibDashboardPluginApi","section":"def-public.DashboardSavedObject","text":"DashboardSavedObject"}," extends ",{"pluginId":"savedObjects","scope":"public","docId":"kibSavedObjectsPluginApi","section":"def-public.SavedObject","text":"SavedObject"}],"description":[],"children":[{"id":"def-public.DashboardSavedObject.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L19"},"signature":["string | undefined"]},{"id":"def-public.DashboardSavedObject.timeRestore","type":"boolean","label":"timeRestore","description":[],"source":{"path":"src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L20"}},{"id":"def-public.DashboardSavedObject.timeTo","type":"string","label":"timeTo","description":[],"source":{"path":"src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L21"},"signature":["string | undefined"]},{"id":"def-public.DashboardSavedObject.timeFrom","type":"string","label":"timeFrom","description":[],"source":{"path":"src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L22"},"signature":["string | undefined"]},{"id":"def-public.DashboardSavedObject.description","type":"string","label":"description","description":[],"source":{"path":"src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L23"},"signature":["string | undefined"]},{"id":"def-public.DashboardSavedObject.panelsJSON","type":"string","label":"panelsJSON","description":[],"source":{"path":"src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L24"}},{"id":"def-public.DashboardSavedObject.optionsJSON","type":"string","label":"optionsJSON","description":[],"source":{"path":"src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L25"},"signature":["string | undefined"]},{"id":"def-public.DashboardSavedObject.uiStateJSON","type":"string","label":"uiStateJSON","description":[],"source":{"path":"src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L27"},"signature":["string | undefined"]},{"id":"def-public.DashboardSavedObject.lastSavedTitle","type":"string","label":"lastSavedTitle","description":[],"source":{"path":"src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L28"}},{"id":"def-public.DashboardSavedObject.refreshInterval","type":"Object","label":"refreshInterval","description":[],"source":{"path":"src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L29"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.RefreshInterval","text":"RefreshInterval"}," | undefined"]},{"id":"def-public.DashboardSavedObject.searchSource","type":"Object","label":"searchSource","description":[],"source":{"path":"src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L30"},"signature":["Pick<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"},", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">"]},{"id":"def-public.DashboardSavedObject.getQuery","type":"Function","label":"getQuery","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.Query","text":"Query"}],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L31"}},{"id":"def-public.DashboardSavedObject.getFilters","type":"Function","label":"getFilters","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L32"}},{"id":"def-public.DashboardSavedObject.getFullEditPath","type":"Function","label":"getFullEditPath","description":[],"source":{"path":"src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L33"},"signature":["(editMode?: boolean | undefined) => string"]}],"source":{"path":"src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts#L18"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-public.DASHBOARD_CONTAINER_TYPE","type":"string","label":"DASHBOARD_CONTAINER_TYPE","description":[],"source":{"path":"src/plugins/dashboard/public/application/embeddable/dashboard_constants.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/application/embeddable/dashboard_constants.ts#L13"},"signature":["\"dashboard\""],"initialIsOpen":false},{"id":"def-public.DashboardUrlGenerator","type":"Type","label":"DashboardUrlGenerator","description":[],"source":{"path":"src/plugins/dashboard/public/plugin.tsx","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/plugin.tsx#L86"},"signature":["UrlGeneratorContract<\"DASHBOARD_APP_URL_GENERATOR\">"],"initialIsOpen":false},{"id":"def-public.DASHBOARD_APP_URL_GENERATOR","type":"string","label":"DASHBOARD_APP_URL_GENERATOR","description":[],"source":{"path":"src/plugins/dashboard/public/url_generator.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/url_generator.ts#L27"},"signature":["\"DASHBOARD_APP_URL_GENERATOR\""],"initialIsOpen":false},{"id":"def-public.SavedDashboardPanel","type":"Type","label":"SavedDashboardPanel","description":["\nThis should always represent the latest dashboard panel shape, after all possible migrations."],"source":{"path":"src/plugins/dashboard/common/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/types.ts#L33"},"signature":["Pick & { readonly id?: string | undefined; readonly type: string; }"],"initialIsOpen":false}],"objects":[{"id":"def-public.DashboardConstants","type":"Object","children":[{"id":"def-public.DashboardConstants.LANDING_PAGE_PATH","type":"string","label":"LANDING_PAGE_PATH","description":[],"source":{"path":"src/plugins/dashboard/public/dashboard_constants.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/dashboard_constants.ts#L12"}},{"id":"def-public.DashboardConstants.CREATE_NEW_DASHBOARD_URL","type":"string","label":"CREATE_NEW_DASHBOARD_URL","description":[],"source":{"path":"src/plugins/dashboard/public/dashboard_constants.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/dashboard_constants.ts#L13"}},{"id":"def-public.DashboardConstants.VIEW_DASHBOARD_URL","type":"string","label":"VIEW_DASHBOARD_URL","description":[],"source":{"path":"src/plugins/dashboard/public/dashboard_constants.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/dashboard_constants.ts#L14"}},{"id":"def-public.DashboardConstants.ADD_EMBEDDABLE_ID","type":"string","label":"ADD_EMBEDDABLE_ID","description":[],"source":{"path":"src/plugins/dashboard/public/dashboard_constants.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/dashboard_constants.ts#L15"}},{"id":"def-public.DashboardConstants.ADD_EMBEDDABLE_TYPE","type":"string","label":"ADD_EMBEDDABLE_TYPE","description":[],"source":{"path":"src/plugins/dashboard/public/dashboard_constants.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/dashboard_constants.ts#L16"}},{"id":"def-public.DashboardConstants.DASHBOARDS_ID","type":"string","label":"DASHBOARDS_ID","description":[],"source":{"path":"src/plugins/dashboard/public/dashboard_constants.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/dashboard_constants.ts#L17"}},{"id":"def-public.DashboardConstants.DASHBOARD_ID","type":"string","label":"DASHBOARD_ID","description":[],"source":{"path":"src/plugins/dashboard/public/dashboard_constants.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/dashboard_constants.ts#L18"}},{"id":"def-public.DashboardConstants.SEARCH_SESSION_ID","type":"string","label":"SEARCH_SESSION_ID","description":[],"source":{"path":"src/plugins/dashboard/public/dashboard_constants.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/dashboard_constants.ts#L19"}}],"description":[],"label":"DashboardConstants","source":{"path":"src/plugins/dashboard/public/dashboard_constants.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/dashboard_constants.ts#L11"},"initialIsOpen":false}],"setup":{"id":"def-public.DashboardSetup","type":"Type","label":"DashboardSetup","description":[],"source":{"path":"src/plugins/dashboard/public/plugin.tsx","lineNumber":118,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/plugin.tsx#L118"},"signature":["void"],"lifecycle":"setup","initialIsOpen":true},"start":{"id":"def-public.DashboardStart","type":"Interface","label":"DashboardStart","description":[],"children":[{"id":"def-public.DashboardStart.getSavedDashboardLoader","type":"Function","label":"getSavedDashboardLoader","description":[],"source":{"path":"src/plugins/dashboard/public/plugin.tsx","lineNumber":121,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/plugin.tsx#L121"},"signature":["() => ",{"pluginId":"savedObjects","scope":"public","docId":"kibSavedObjectsPluginApi","section":"def-public.SavedObjectLoader","text":"SavedObjectLoader"}]},{"id":"def-public.DashboardStart.dashboardUrlGenerator","type":"Object","label":"dashboardUrlGenerator","description":[],"source":{"path":"src/plugins/dashboard/public/plugin.tsx","lineNumber":122,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/plugin.tsx#L122"},"signature":[{"pluginId":"dashboard","scope":"public","docId":"kibDashboardPluginApi","section":"def-public.DashboardUrlGenerator","text":"DashboardUrlGenerator"}," | undefined"]},{"id":"def-public.DashboardStart.dashboardFeatureFlagConfig","type":"Object","label":"dashboardFeatureFlagConfig","description":[],"source":{"path":"src/plugins/dashboard/public/plugin.tsx","lineNumber":123,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/plugin.tsx#L123"},"signature":[{"pluginId":"dashboard","scope":"public","docId":"kibDashboardPluginApi","section":"def-public.DashboardFeatureFlagConfig","text":"DashboardFeatureFlagConfig"}]},{"id":"def-public.DashboardStart.DashboardContainerByValueRenderer","type":"Function","label":"DashboardContainerByValueRenderer","description":[],"source":{"path":"src/plugins/dashboard/public/plugin.tsx","lineNumber":124,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/plugin.tsx#L124"},"signature":["React.FC"]}],"source":{"path":"src/plugins/dashboard/public/plugin.tsx","lineNumber":120,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/public/plugin.tsx#L120"},"lifecycle":"start","initialIsOpen":true}},"server":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"common":{"classes":[],"functions":[{"id":"def-common.migratePanelsTo730","type":"Function","label":"migratePanelsTo730","signature":["(panels: (","RawSavedDashboardPanelTo60"," | ","RawSavedDashboardPanel610"," | ","RawSavedDashboardPanel620"," | Pick<","RawSavedDashboardPanel620",", \"title\" | \"panelIndex\" | \"name\" | \"gridData\" | \"version\" | \"embeddableConfig\"> | ",{"pluginId":"dashboard","scope":"common","docId":"kibDashboardPluginApi","section":"def-common.SavedDashboardPanelTo60","text":"SavedDashboardPanelTo60"}],"description":[],"children":[{"type":"Array","label":"panels","isRequired":true,"signature":["(",{"pluginId":"dashboard","scope":"common","docId":"kibDashboardPluginApi","section":"def-common.RawSavedDashboardPanelTo60","text":"RawSavedDashboardPanelTo60"}," | ",{"pluginId":"dashboard","scope":"common","docId":"kibDashboardPluginApi","section":"def-common.RawSavedDashboardPanel610","text":"RawSavedDashboardPanel610"}," | ",{"pluginId":"dashboard","scope":"common","docId":"kibDashboardPluginApi","section":"def-common.RawSavedDashboardPanel620","text":"RawSavedDashboardPanel620"}," | Pick<",{"pluginId":"dashboard","scope":"common","docId":"kibDashboardPluginApi","section":"def-common.RawSavedDashboardPanel620","text":"RawSavedDashboardPanel620"},", \"title\" | \"panelIndex\" | \"name\" | \"gridData\" | \"version\" | \"embeddableConfig\"> | ",{"pluginId":"dashboard","scope":"common","docId":"kibDashboardPluginApi","section":"def-common.SavedDashboardPanelTo60","text":"SavedDashboardPanelTo60"}],"description":[],"source":{"path":"src/plugins/dashboard/common/migrate_to_730_panels.ts","lineNumber":262,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/migrate_to_730_panels.ts#L262"}},{"type":"string","label":"version","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/dashboard/common/migrate_to_730_panels.ts","lineNumber":274,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/migrate_to_730_panels.ts#L274"}},{"type":"boolean","label":"useMargins","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/dashboard/common/migrate_to_730_panels.ts","lineNumber":275,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/migrate_to_730_panels.ts#L275"}},{"id":"def-common.migratePanelsTo730.uiState","type":"Object","label":"uiState","description":[],"children":[{"id":"def-common.migratePanelsTo730.uiState.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/plugins/dashboard/common/migrate_to_730_panels.ts","lineNumber":276,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/migrate_to_730_panels.ts#L276"},"signature":["any"]}],"source":{"path":"src/plugins/dashboard/common/migrate_to_730_panels.ts","lineNumber":276,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/migrate_to_730_panels.ts#L276"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/dashboard/common/migrate_to_730_panels.ts","lineNumber":261,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/migrate_to_730_panels.ts#L261"},"initialIsOpen":false}],"interfaces":[{"id":"def-common.GridData","type":"Interface","label":"GridData","description":[],"children":[{"id":"def-common.GridData.w","type":"number","label":"w","description":[],"source":{"path":"src/plugins/dashboard/common/embeddable/types.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/embeddable/types.ts#L10"}},{"id":"def-common.GridData.h","type":"number","label":"h","description":[],"source":{"path":"src/plugins/dashboard/common/embeddable/types.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/embeddable/types.ts#L11"}},{"id":"def-common.GridData.x","type":"number","label":"x","description":[],"source":{"path":"src/plugins/dashboard/common/embeddable/types.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/embeddable/types.ts#L12"}},{"id":"def-common.GridData.y","type":"number","label":"y","description":[],"source":{"path":"src/plugins/dashboard/common/embeddable/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/embeddable/types.ts#L13"}},{"id":"def-common.GridData.i","type":"string","label":"i","description":[],"source":{"path":"src/plugins/dashboard/common/embeddable/types.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/embeddable/types.ts#L14"}}],"source":{"path":"src/plugins/dashboard/common/embeddable/types.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/embeddable/types.ts#L9"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-common.RawSavedDashboardPanel730ToLatest","type":"Type","label":"RawSavedDashboardPanel730ToLatest","description":[],"source":{"path":"src/plugins/dashboard/common/bwc/types.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/bwc/types.ts#L70"},"signature":["Pick, \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly type?: string | undefined; readonly name?: string | undefined; panelIndex: string; }"],"initialIsOpen":false},{"id":"def-common.DashboardDoc730ToLatest","type":"Type","label":"DashboardDoc730ToLatest","description":[],"source":{"path":"src/plugins/dashboard/common/bwc/types.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/bwc/types.ts#L53"},"signature":["Doc"],"initialIsOpen":false},{"id":"def-common.DashboardDoc700To720","type":"Type","label":"DashboardDoc700To720","description":[],"source":{"path":"src/plugins/dashboard/common/bwc/types.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/bwc/types.ts#L55"},"signature":["Doc"],"initialIsOpen":false},{"id":"def-common.DashboardDocPre700","type":"Type","label":"DashboardDocPre700","description":[],"source":{"path":"src/plugins/dashboard/common/bwc/types.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/bwc/types.ts#L57"},"signature":["DocPre700"],"initialIsOpen":false},{"id":"def-common.SavedDashboardPanelTo60","type":"Type","label":"SavedDashboardPanelTo60","description":[],"source":{"path":"src/plugins/dashboard/common/types.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/types.ts#L67"},"signature":["Pick & { readonly id: string; readonly type: string; }"],"initialIsOpen":false},{"id":"def-common.SavedDashboardPanel610","type":"Type","label":"SavedDashboardPanel610","description":[],"source":{"path":"src/plugins/dashboard/common/types.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/types.ts#L59"},"signature":["Pick & { readonly id: string; readonly type: string; }"],"initialIsOpen":false},{"id":"def-common.SavedDashboardPanel620","type":"Type","label":"SavedDashboardPanel620","description":[],"source":{"path":"src/plugins/dashboard/common/types.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/types.ts#L51"},"signature":["Pick & { readonly id: string; readonly type: string; }"],"initialIsOpen":false},{"id":"def-common.SavedDashboardPanel630","type":"Type","label":"SavedDashboardPanel630","description":[],"source":{"path":"src/plugins/dashboard/common/types.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/types.ts#L43"},"signature":["Pick & { readonly id: string; readonly type: string; }"],"initialIsOpen":false},{"id":"def-common.SavedDashboardPanel640To720","type":"Type","label":"SavedDashboardPanel640To720","description":[],"source":{"path":"src/plugins/dashboard/common/types.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/types.ts#L35"},"signature":["Pick, \"title\" | \"panelIndex\" | \"gridData\" | \"version\" | \"embeddableConfig\"> & { readonly id: string; readonly type: string; }"],"initialIsOpen":false},{"id":"def-common.SavedDashboardPanel730ToLatest","type":"Type","label":"SavedDashboardPanel730ToLatest","description":[],"source":{"path":"src/plugins/dashboard/common/types.ts","lineNumber":76,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dashboard/common/types.ts#L76"},"signature":["Pick & { readonly id?: string | undefined; readonly type: string; }"],"initialIsOpen":false}],"objects":[]}} \ No newline at end of file diff --git a/api_docs/dashboard.mdx b/api_docs/dashboard.mdx new file mode 100644 index 0000000000000..267a6d47c7ad0 --- /dev/null +++ b/api_docs/dashboard.mdx @@ -0,0 +1,36 @@ +--- +id: kibDashboardPluginApi +slug: /kibana-dev-docs/dashboardPluginApi +title: dashboard +image: https://source.unsplash.com/400x175/?github +summary: API docs for the dashboard plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboard'] +--- + +import dashboardObj from './dashboard.json'; + +## Client + +### Setup + +### Start + +### Objects + +### Functions + +### Classes + +### Interfaces + +### Consts, variables and types + +## Common + +### Functions + +### Interfaces + +### Consts, variables and types + diff --git a/api_docs/dashboard_enhanced.json b/api_docs/dashboard_enhanced.json new file mode 100644 index 0000000000000..5dd74debf286c --- /dev/null +++ b/api_docs/dashboard_enhanced.json @@ -0,0 +1 @@ +{"id":"dashboardEnhanced","client":{"classes":[{"id":"def-public.AbstractDashboardDrilldown","type":"Class","label":"AbstractDashboardDrilldown","description":[],"signature":[{"pluginId":"dashboardEnhanced","scope":"public","docId":"kibDashboardEnhancedPluginApi","section":"def-public.AbstractDashboardDrilldown","text":"AbstractDashboardDrilldown"}," implements ",{"pluginId":"uiActionsEnhanced","scope":"public","docId":"kibUiActionsEnhancedPluginApi","section":"def-public.DrilldownDefinition","text":"DrilldownDefinition"},"<",{"pluginId":"dashboardEnhanced","scope":"common","docId":"kibDashboardEnhancedPluginApi","section":"def-common.DrilldownConfig","text":"DrilldownConfig"},", Context, ",{"pluginId":"uiActionsEnhanced","scope":"public","docId":"kibUiActionsEnhancedPluginApi","section":"def-public.BaseActionFactoryContext","text":"BaseActionFactoryContext"},">"],"children":[{"id":"def-public.AbstractDashboardDrilldown.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"params","isRequired":true,"signature":[{"pluginId":"dashboardEnhanced","scope":"public","docId":"kibDashboardEnhancedPluginApi","section":"def-public.Params","text":"Params"}],"description":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L36"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L36"}},{"id":"def-public.AbstractDashboardDrilldown.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L38"}},{"id":"def-public.AbstractDashboardDrilldown.supportedTriggers","type":"Function","label":"supportedTriggers","description":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L40"},"signature":["() => string[]"]},{"id":"def-public.AbstractDashboardDrilldown.getURL","type":"Function","label":"getURL","signature":["(config: ",{"pluginId":"dashboardEnhanced","scope":"common","docId":"kibDashboardEnhancedPluginApi","section":"def-common.DrilldownConfig","text":"DrilldownConfig"},", context: Context) => Promise<",{"pluginId":"share","scope":"public","docId":"kibSharePluginApi","section":"def-public.KibanaURL","text":"KibanaURL"},">"],"description":[],"children":[{"type":"Object","label":"config","isRequired":true,"signature":[{"pluginId":"dashboardEnhanced","scope":"common","docId":"kibDashboardEnhancedPluginApi","section":"def-common.DrilldownConfig","text":"DrilldownConfig"}],"description":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L42"}},{"type":"Uncategorized","label":"context","isRequired":true,"signature":["Context"],"description":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L42"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L42"}},{"id":"def-public.AbstractDashboardDrilldown.order","type":"number","label":"order","description":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L44"},"signature":["100"]},{"id":"def-public.AbstractDashboardDrilldown.getDisplayName","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"getDisplayName","source":{"path":"x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L46"},"returnComment":[]},{"id":"def-public.AbstractDashboardDrilldown.euiIcon","type":"string","label":"euiIcon","description":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L48"},"signature":["\"dashboardApp\""]},{"id":"def-public.AbstractDashboardDrilldown.CollectConfig","type":"Function","label":"CollectConfig","description":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L54"},"signature":[{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.UiComponent","text":"UiComponent"},"<",{"pluginId":"kibanaUtils","scope":"public","docId":"kibKibanaUtilsPluginApi","section":"def-public.CollectConfigProps","text":"CollectConfigProps"},"<",{"pluginId":"dashboardEnhanced","scope":"common","docId":"kibDashboardEnhancedPluginApi","section":"def-common.DrilldownConfig","text":"DrilldownConfig"},", ",{"pluginId":"uiActionsEnhanced","scope":"public","docId":"kibUiActionsEnhancedPluginApi","section":"def-public.BaseActionFactoryContext","text":"BaseActionFactoryContext"},">>"]},{"id":"def-public.AbstractDashboardDrilldown.createConfig","type":"Function","children":[],"signature":["() => { dashboardId: string; useCurrentFilters: boolean; useCurrentDateRange: boolean; }"],"description":[],"label":"createConfig","source":{"path":"x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L56"},"returnComment":[]},{"id":"def-public.AbstractDashboardDrilldown.isConfigValid","type":"Function","children":[{"type":"Object","label":"config","isRequired":true,"signature":[{"pluginId":"dashboardEnhanced","scope":"common","docId":"kibDashboardEnhancedPluginApi","section":"def-common.DrilldownConfig","text":"DrilldownConfig"}],"description":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L62"}}],"signature":["(config: ",{"pluginId":"dashboardEnhanced","scope":"common","docId":"kibDashboardEnhancedPluginApi","section":"def-common.DrilldownConfig","text":"DrilldownConfig"},") => config is ",{"pluginId":"dashboardEnhanced","scope":"common","docId":"kibDashboardEnhancedPluginApi","section":"def-common.DrilldownConfig","text":"DrilldownConfig"}],"description":[],"label":"isConfigValid","source":{"path":"x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L62"},"returnComment":[]},{"id":"def-public.AbstractDashboardDrilldown.getHref","type":"Function","children":[{"type":"Object","label":"config","isRequired":true,"signature":[{"pluginId":"dashboardEnhanced","scope":"common","docId":"kibDashboardEnhancedPluginApi","section":"def-common.DrilldownConfig","text":"DrilldownConfig"}],"description":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L67"}},{"type":"Uncategorized","label":"context","isRequired":true,"signature":["Context"],"description":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L67"}}],"signature":["(config: ",{"pluginId":"dashboardEnhanced","scope":"common","docId":"kibDashboardEnhancedPluginApi","section":"def-common.DrilldownConfig","text":"DrilldownConfig"},", context: Context) => Promise"],"description":[],"label":"getHref","source":{"path":"x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L67"},"returnComment":[]},{"id":"def-public.AbstractDashboardDrilldown.execute","type":"Function","children":[{"type":"Object","label":"config","isRequired":true,"signature":[{"pluginId":"dashboardEnhanced","scope":"common","docId":"kibDashboardEnhancedPluginApi","section":"def-common.DrilldownConfig","text":"DrilldownConfig"}],"description":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L72"}},{"type":"Uncategorized","label":"context","isRequired":true,"signature":["Context"],"description":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L72"}}],"signature":["(config: ",{"pluginId":"dashboardEnhanced","scope":"common","docId":"kibDashboardEnhancedPluginApi","section":"def-common.DrilldownConfig","text":"DrilldownConfig"},", context: Context) => Promise"],"description":[],"label":"execute","source":{"path":"x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L72"},"returnComment":[]},{"id":"def-public.AbstractDashboardDrilldown.urlGenerator","type":"Object","label":"urlGenerator","description":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L77"},"signature":[{"pluginId":"dashboard","scope":"public","docId":"kibDashboardPluginApi","section":"def-public.DashboardUrlGenerator","text":"DashboardUrlGenerator"}]}],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L34"},"initialIsOpen":false}],"functions":[],"interfaces":[{"id":"def-public.SetupDependencies","type":"Interface","label":"SetupDependencies","description":[],"children":[{"id":"def-public.SetupDependencies.uiActionsEnhanced","type":"Object","label":"uiActionsEnhanced","description":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/plugin.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L17"},"signature":[{"pluginId":"uiActionsEnhanced","scope":"public","docId":"kibUiActionsEnhancedPluginApi","section":"def-public.SetupContract","text":"SetupContract"}]},{"id":"def-public.SetupDependencies.embeddable","type":"Object","label":"embeddable","description":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/plugin.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L18"},"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableSetup","text":"EmbeddableSetup"}]},{"id":"def-public.SetupDependencies.share","type":"CompoundType","label":"share","description":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/plugin.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L19"},"signature":[{"pluginId":"share","scope":"public","docId":"kibSharePluginApi","section":"def-public.SharePluginSetup","text":"SharePluginSetup"}]}],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/plugin.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L16"},"initialIsOpen":false},{"id":"def-public.StartDependencies","type":"Interface","label":"StartDependencies","description":[],"children":[{"id":"def-public.StartDependencies.uiActionsEnhanced","type":"Object","label":"uiActionsEnhanced","description":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/plugin.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L23"},"signature":[{"pluginId":"uiActionsEnhanced","scope":"public","docId":"kibUiActionsEnhancedPluginApi","section":"def-public.StartContract","text":"StartContract"}]},{"id":"def-public.StartDependencies.data","type":"Object","label":"data","description":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/plugin.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L24"},"signature":[{"pluginId":"data","scope":"public","docId":"kibDataPluginApi","section":"def-public.DataPublicPluginStart","text":"DataPublicPluginStart"}]},{"id":"def-public.StartDependencies.embeddable","type":"Object","label":"embeddable","description":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/plugin.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L25"},"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableStart","text":"EmbeddableStart"}]},{"id":"def-public.StartDependencies.share","type":"CompoundType","label":"share","description":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/plugin.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L26"},"signature":[{"pluginId":"share","scope":"public","docId":"kibSharePluginApi","section":"def-public.SharePluginStart","text":"SharePluginStart"}]},{"id":"def-public.StartDependencies.dashboard","type":"Object","label":"dashboard","description":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/plugin.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L27"},"signature":[{"pluginId":"dashboard","scope":"public","docId":"kibDashboardPluginApi","section":"def-public.DashboardStart","text":"DashboardStart"}]}],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/plugin.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L22"},"initialIsOpen":false},{"id":"def-public.Params","type":"Interface","label":"Params","description":[],"children":[{"id":"def-public.Params.start","type":"Function","label":"start","description":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L27"},"signature":[{"pluginId":"kibanaUtils","scope":"public","docId":"kibKibanaUtilsPluginApi","section":"def-public.StartServicesGetter","text":"StartServicesGetter"},"<{ uiActionsEnhanced: ",{"pluginId":"uiActionsEnhanced","scope":"public","docId":"kibUiActionsEnhancedPluginApi","section":"def-public.StartContract","text":"StartContract"},"; data: ",{"pluginId":"data","scope":"public","docId":"kibDataPluginApi","section":"def-public.DataPublicPluginStart","text":"DataPublicPluginStart"},"; dashboard: ",{"pluginId":"dashboard","scope":"public","docId":"kibDashboardPluginApi","section":"def-public.DashboardStart","text":"DashboardStart"},"; }, unknown, ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreStart","text":"CoreStart"}]}],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/abstract_dashboard_drilldown.tsx#L26"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-public.Config","type":"Type","label":"Config","description":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/types.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/services/drilldowns/abstract_dashboard_drilldown/types.ts#L11"},"signature":["{ dashboardId?: string | undefined; useCurrentFilters: boolean; useCurrentDateRange: boolean; }"],"initialIsOpen":false}],"objects":[],"setup":{"id":"def-public.SetupContract","type":"Interface","label":"SetupContract","description":[],"children":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/plugin.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L31"},"lifecycle":"setup","initialIsOpen":true},"start":{"id":"def-public.StartContract","type":"Interface","label":"StartContract","description":[],"children":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/public/plugin.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/public/plugin.ts#L34"},"lifecycle":"start","initialIsOpen":true}},"server":{"classes":[],"functions":[],"interfaces":[{"id":"def-server.SetupDependencies","type":"Interface","label":"SetupDependencies","description":[],"children":[{"id":"def-server.SetupDependencies.uiActionsEnhanced","type":"Object","label":"uiActionsEnhanced","description":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/server/plugin.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/server/plugin.ts#L13"},"signature":[{"pluginId":"uiActionsEnhanced","scope":"server","docId":"kibUiActionsEnhancedPluginApi","section":"def-server.SetupContract","text":"SetupContract"}]}],"source":{"path":"x-pack/plugins/dashboard_enhanced/server/plugin.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/server/plugin.ts#L12"},"initialIsOpen":false},{"id":"def-server.StartDependencies","type":"Interface","label":"StartDependencies","description":[],"children":[{"id":"def-server.StartDependencies.uiActionsEnhanced","type":"Uncategorized","label":"uiActionsEnhanced","description":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/server/plugin.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/server/plugin.ts#L17"},"signature":["void"]}],"source":{"path":"x-pack/plugins/dashboard_enhanced/server/plugin.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/server/plugin.ts#L16"},"initialIsOpen":false}],"enums":[],"misc":[],"objects":[],"setup":{"id":"def-server.SetupContract","type":"Interface","label":"SetupContract","description":[],"children":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/server/plugin.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/server/plugin.ts#L21"},"lifecycle":"setup","initialIsOpen":true},"start":{"id":"def-server.StartContract","type":"Interface","label":"StartContract","description":[],"children":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/server/plugin.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/server/plugin.ts#L24"},"lifecycle":"start","initialIsOpen":true}},"common":{"classes":[],"functions":[{"id":"def-common.createExtract","type":"Function","children":[{"id":"def-common.createExtract.{\n- drilldownId,\n}","type":"Object","label":"{\n drilldownId,\n}","description":[],"children":[{"id":"def-common.createExtract.{\n- drilldownId,\n}.drilldownId","type":"string","label":"drilldownId","description":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts#L49"}}],"source":{"path":"x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts#L48"}}],"signature":["({ drilldownId, }: { drilldownId: string; }) => (state: ",{"pluginId":"uiActionsEnhanced","scope":"common","docId":"kibUiActionsEnhancedPluginApi","section":"def-common.SerializedEvent","text":"SerializedEvent"},") => { state: ",{"pluginId":"uiActionsEnhanced","scope":"common","docId":"kibUiActionsEnhancedPluginApi","section":"def-common.SerializedEvent","text":"SerializedEvent"},"; references: ","SavedObjectReference","[]; }"],"description":[],"label":"createExtract","source":{"path":"x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts#L46"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.createInject","type":"Function","children":[{"id":"def-common.createInject.{\n- drilldownId,\n}","type":"Object","label":"{\n drilldownId,\n}","description":[],"children":[{"id":"def-common.createInject.{\n- drilldownId,\n}.drilldownId","type":"string","label":"drilldownId","description":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts#L34"}}],"source":{"path":"x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts#L33"}}],"signature":["({ drilldownId, }: { drilldownId: string; }) => (state: ",{"pluginId":"uiActionsEnhanced","scope":"common","docId":"kibUiActionsEnhancedPluginApi","section":"def-common.SerializedEvent","text":"SerializedEvent"},", references: ","SavedObjectReference","[]) => ",{"pluginId":"uiActionsEnhanced","scope":"common","docId":"kibUiActionsEnhancedPluginApi","section":"def-common.SerializedEvent","text":"SerializedEvent"}],"description":[],"label":"createInject","source":{"path":"x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/dashboard_drilldown_persistable_state.ts#L31"},"returnComment":[],"initialIsOpen":false}],"interfaces":[],"enums":[],"misc":[{"id":"def-common.EMBEDDABLE_TO_DASHBOARD_DRILLDOWN","type":"string","label":"EMBEDDABLE_TO_DASHBOARD_DRILLDOWN","description":["\nNOTE: DO NOT CHANGE THIS STRING WITHOUT CAREFUL CONSIDERATOIN, BECAUSE IT IS\nSTORED IN SAVED OBJECTS.\n\nAlso temporary dashboard drilldown migration code inside embeddable plugin relies on it\nx-pack/plugins/embeddable_enhanced/public/embeddables/embeddable_action_storage.ts"],"source":{"path":"x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/constants.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/constants.ts#L15"},"signature":["\"DASHBOARD_TO_DASHBOARD_DRILLDOWN\""],"initialIsOpen":false},{"id":"def-common.DrilldownConfig","type":"Type","label":"DrilldownConfig","description":[],"source":{"path":"x-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/types.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_enhanced/common/drilldowns/dashboard_drilldown/types.ts#L9"},"signature":["{ dashboardId?: string | undefined; useCurrentFilters: boolean; useCurrentDateRange: boolean; }"],"initialIsOpen":false}],"objects":[]}} \ No newline at end of file diff --git a/api_docs/dashboard_enhanced.mdx b/api_docs/dashboard_enhanced.mdx new file mode 100644 index 0000000000000..7c8a920cd33cb --- /dev/null +++ b/api_docs/dashboard_enhanced.mdx @@ -0,0 +1,38 @@ +--- +id: kibDashboardEnhancedPluginApi +slug: /kibana-dev-docs/dashboardEnhancedPluginApi +title: dashboardEnhanced +image: https://source.unsplash.com/400x175/?github +summary: API docs for the dashboardEnhanced plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardEnhanced'] +--- + +import dashboardEnhancedObj from './dashboard_enhanced.json'; + +## Client + +### Setup + +### Start + +### Classes + +### Interfaces + +### Consts, variables and types + +## Server + +### Setup + +### Start + +### Interfaces + +## Common + +### Functions + +### Consts, variables and types + diff --git a/api_docs/dashboard_mode.json b/api_docs/dashboard_mode.json new file mode 100644 index 0000000000000..c41752466eca6 --- /dev/null +++ b/api_docs/dashboard_mode.json @@ -0,0 +1 @@ +{"id":"dashboardMode","client":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"server":{"classes":[{"id":"def-server.DashboardModeServerPlugin","type":"Class","label":"DashboardModeServerPlugin","description":[],"signature":[{"pluginId":"dashboardMode","scope":"server","docId":"kibDashboardModePluginApi","section":"def-server.DashboardModeServerPlugin","text":"DashboardModeServerPlugin"}," implements ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.Plugin","text":"Plugin"},""],"children":[{"id":"def-server.DashboardModeServerPlugin.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"initializerContext","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.PluginInitializerContext","text":"PluginInitializerContext"},""],"description":[],"source":{"path":"x-pack/plugins/dashboard_mode/server/plugin.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/server/plugin.ts#L30"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/dashboard_mode/server/plugin.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/server/plugin.ts#L30"}},{"id":"def-server.DashboardModeServerPlugin.setup","type":"Function","label":"setup","signature":["(core: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreSetup","text":"CoreSetup"},", { security }: DashboardModeServerSetupDependencies) => void"],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreSetup","text":"CoreSetup"},""],"description":[],"source":{"path":"x-pack/plugins/dashboard_mode/server/plugin.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/server/plugin.ts#L34"}},{"type":"Object","label":"{ security }","isRequired":true,"signature":["DashboardModeServerSetupDependencies"],"description":[],"source":{"path":"x-pack/plugins/dashboard_mode/server/plugin.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/server/plugin.ts#L34"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/dashboard_mode/server/plugin.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/server/plugin.ts#L34"}},{"id":"def-server.DashboardModeServerPlugin.start","type":"Function","label":"start","signature":["(core: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreStart","text":"CoreStart"},") => void"],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreStart","text":"CoreStart"}],"description":[],"source":{"path":"x-pack/plugins/dashboard_mode/server/plugin.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/server/plugin.ts#L60"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/dashboard_mode/server/plugin.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/server/plugin.ts#L60"}},{"id":"def-server.DashboardModeServerPlugin.stop","type":"Function","label":"stop","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/dashboard_mode/server/plugin.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/server/plugin.ts#L62"}}],"source":{"path":"x-pack/plugins/dashboard_mode/server/plugin.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/server/plugin.ts#L26"},"initialIsOpen":false}],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[{"id":"def-common.UI_SETTINGS","type":"Object","children":[{"id":"def-common.UI_SETTINGS.CONFIG_DASHBOARD_ONLY_MODE_ROLES","type":"string","label":"CONFIG_DASHBOARD_ONLY_MODE_ROLES","description":[],"source":{"path":"x-pack/plugins/dashboard_mode/common/constants.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/common/constants.ts#L9"}}],"description":[],"label":"UI_SETTINGS","source":{"path":"x-pack/plugins/dashboard_mode/common/constants.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/dashboard_mode/common/constants.ts#L8"},"initialIsOpen":false}]}} \ No newline at end of file diff --git a/api_docs/dashboard_mode.mdx b/api_docs/dashboard_mode.mdx new file mode 100644 index 0000000000000..5104a989a44c5 --- /dev/null +++ b/api_docs/dashboard_mode.mdx @@ -0,0 +1,20 @@ +--- +id: kibDashboardModePluginApi +slug: /kibana-dev-docs/dashboardModePluginApi +title: dashboardMode +image: https://source.unsplash.com/400x175/?github +summary: API docs for the dashboardMode plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dashboardMode'] +--- + +import dashboardModeObj from './dashboard_mode.json'; + +## Server + +### Classes + +## Common + +### Objects + diff --git a/api_docs/data.json b/api_docs/data.json new file mode 100644 index 0000000000000..059d3f28b2a9d --- /dev/null +++ b/api_docs/data.json @@ -0,0 +1 @@ +{"id":"data","client":{"classes":[{"id":"def-public.FieldFormat","type":"Class","label":"FieldFormat","description":[],"children":[{"id":"def-public.FieldFormat.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L32"}},{"id":"def-public.FieldFormat.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L38"}},{"id":"def-public.FieldFormat.fieldType","type":"CompoundType","label":"fieldType","description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L44"},"signature":["string | string[]"]},{"id":"def-public.FieldFormat.convertObject","type":"Object","label":"convertObject","description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L52"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatConvert","text":"FieldFormatConvert"}," | undefined"]},{"id":"def-public.FieldFormat.htmlConvert","type":"Function","label":"htmlConvert","description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L60"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.HtmlContextTypeConvert","text":"HtmlContextTypeConvert"}," | undefined"]},{"id":"def-public.FieldFormat.textConvert","type":"Function","label":"textConvert","description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L68"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.TextContextTypeConvert","text":"TextContextTypeConvert"}," | undefined"]},{"id":"def-public.FieldFormat.type","type":"Any","label":"type","description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L74"},"signature":["any"]},{"id":"def-public.FieldFormat.allowsNumericalAggregations","type":"CompoundType","label":"allowsNumericalAggregations","description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L75"},"signature":["boolean | undefined"]},{"id":"def-public.FieldFormat._params","type":"Any","label":"_params","description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L77"},"signature":["any"]},{"id":"def-public.FieldFormat.getConfig","type":"Function","label":"getConfig","description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L78"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.GetConfigFn","text":"GetConfigFn"}," | undefined"]},{"id":"def-public.FieldFormat.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"_params","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.IFieldFormatMetaParams","text":"IFieldFormatMetaParams"}],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L80"}},{"type":"Function","label":"getConfig","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.GetConfigFn","text":"GetConfigFn"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L80"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L80"}},{"id":"def-public.FieldFormat.convert","type":"Function","label":"convert","signature":["(value: any, contentType?: ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatsContentType","text":"FieldFormatsContentType"},", options?: Record | ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.HtmlContextTypeOptions","text":"HtmlContextTypeOptions"}," | undefined) => string"],"description":["\nConvert a raw value to a formatted string"],"children":[{"type":"Any","label":"value","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L99"}},{"type":"CompoundType","label":"contentType","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatsContentType","text":"FieldFormatsContentType"}],"description":["- optional content type, the only two contentTypes\ncurrently supported are \"html\" and \"text\", which helps\nformatters adjust to different contexts"],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":100,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L100"}},{"type":"CompoundType","label":"options","isRequired":false,"signature":["Record | ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.HtmlContextTypeOptions","text":"HtmlContextTypeOptions"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L101"}}],"tags":["return","public"],"returnComment":["- the formatted string, which is assumed to be html, safe for\n injecting into the DOM or a DOM attribute"],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L98"}},{"id":"def-public.FieldFormat.getConverterFor","type":"Function","label":"getConverterFor","signature":["(contentType?: ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatsContentType","text":"FieldFormatsContentType"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatConvertFunction","text":"FieldFormatConvertFunction"}],"description":["\nGet a convert function that is bound to a specific contentType"],"children":[{"type":"CompoundType","label":"contentType","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatsContentType","text":"FieldFormatsContentType"}],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":119,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L119"}}],"tags":["return","public"],"returnComment":["- a bound converter function"],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":118,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L118"}},{"id":"def-public.FieldFormat.getParamDefaults","type":"Function","label":"getParamDefaults","signature":["() => Record"],"description":["\nGet parameter defaults"],"children":[],"tags":["return","public"],"returnComment":["- parameter defaults"],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":133,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L133"}},{"id":"def-public.FieldFormat.param","type":"Function","label":"param","signature":["(name: string) => any"],"description":["\nGet the value of a param. This value may be a default value.\n"],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":["- the param name to fetch"],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":144,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L144"}}],"tags":["return","public"],"returnComment":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":144,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L144"}},{"id":"def-public.FieldFormat.params","type":"Function","label":"params","signature":["() => Record"],"description":["\nGet all of the params in a single object"],"children":[],"tags":["return","public"],"returnComment":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":161,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L161"}},{"id":"def-public.FieldFormat.toJSON","type":"Function","label":"toJSON","signature":["() => { id: any; params: any; }"],"description":["\nSerialize this format to a simple POJO, with only the params\nthat are not default\n"],"children":[],"tags":["return","public"],"returnComment":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":172,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L172"}},{"id":"def-public.FieldFormat.from","type":"Function","label":"from","signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"},".from"],"description":[],"children":[{"type":"Function","label":"convertFn","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatConvertFunction","text":"FieldFormatConvertFunction"}],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":193,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L193"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":193,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L193"}},{"id":"def-public.FieldFormat.setupContentType","type":"Function","label":"setupContentType","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatConvert","text":"FieldFormatConvert"}],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":197,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L197"}},{"id":"def-public.FieldFormat.isInstanceOfFieldFormat","type":"Function","label":"isInstanceOfFieldFormat","signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"},".isInstanceOfFieldFormat"],"description":[],"children":[{"type":"Any","label":"fieldFormat","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":204,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L204"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":204,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L204"}}],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L26"},"initialIsOpen":false},{"id":"def-public.IndexPatternsService","type":"Class","label":"IndexPatternsService","description":[],"children":[{"id":"def-public.IndexPatternsService.ensureDefaultIndexPattern","type":"Function","label":"ensureDefaultIndexPattern","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L67"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.EnsureDefaultIndexPattern","text":"EnsureDefaultIndexPattern"}]},{"id":"def-public.IndexPatternsService.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"{\n uiSettings,\n savedObjectsClient,\n apiClient,\n fieldFormats,\n onNotification,\n onError,\n onRedirectNoIndexPattern = () => {},\n }","isRequired":true,"signature":["IndexPatternsServiceDeps"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L69"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L69"}},{"id":"def-public.IndexPatternsService.getIds","type":"Function","children":[{"type":"boolean","label":"refresh","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L108"}}],"signature":["(refresh?: boolean) => Promise"],"description":["\nGet list of index pattern ids"],"label":"getIds","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L108"},"returnComment":[]},{"id":"def-public.IndexPatternsService.getTitles","type":"Function","children":[{"type":"boolean","label":"refresh","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":122,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L122"}}],"signature":["(refresh?: boolean) => Promise"],"description":["\nGet list of index pattern titles"],"label":"getTitles","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":122,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L122"},"returnComment":[]},{"id":"def-public.IndexPatternsService.find","type":"Function","children":[{"type":"string","label":"search","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":138,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L138"}},{"type":"number","label":"size","isRequired":true,"signature":["number"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":138,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L138"}}],"signature":["(search: string, size?: number) => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},"[]>"],"description":["\nFind and load index patterns by title"],"label":"find","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":138,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L138"},"returnComment":["IndexPattern[]"]},{"id":"def-public.IndexPatternsService.getIdsWithTitle","type":"Function","children":[{"type":"boolean","label":"refresh","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":157,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L157"}}],"signature":["(refresh?: boolean) => Promise<{ id: string; title: string; }[]>"],"description":["\nGet list of index pattern ids with titles"],"label":"getIdsWithTitle","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":156,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L156"},"returnComment":[]},{"id":"def-public.IndexPatternsService.clearCache","type":"Function","children":[{"type":"string","label":"id","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":175,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L175"}}],"signature":["(id?: string | undefined) => void"],"description":["\nClear index pattern list cache"],"label":"clearCache","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":175,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L175"},"returnComment":[]},{"id":"def-public.IndexPatternsService.getCache","type":"Function","children":[],"signature":["() => Promise<",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},"<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSavedObjectAttrs","text":"IndexPatternSavedObjectAttrs"},">[] | null | undefined>"],"description":[],"label":"getCache","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":184,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L184"},"returnComment":[]},{"id":"def-public.IndexPatternsService.getDefault","type":"Function","children":[],"signature":["() => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}," | null>"],"description":["\nGet default index pattern"],"label":"getDefault","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":194,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L194"},"returnComment":[]},{"id":"def-public.IndexPatternsService.setDefault","type":"Function","children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":208,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L208"}},{"type":"boolean","label":"force","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":208,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L208"}}],"signature":["(id: string, force?: boolean) => Promise"],"description":["\nOptionally set default index pattern, unless force = true"],"label":"setDefault","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":208,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L208"},"returnComment":[]},{"id":"def-public.IndexPatternsService.getFieldsForWildcard","type":"Function","children":[{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.GetFieldsOptions","text":"GetFieldsOptions"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":219,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L219"}}],"signature":["(options: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.GetFieldsOptions","text":"GetFieldsOptions"},") => Promise"],"description":["\nGet field list by providing { pattern }"],"label":"getFieldsForWildcard","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":219,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L219"},"returnComment":["FieldSpec[]"]},{"id":"def-public.IndexPatternsService.getFieldsForIndexPattern","type":"Function","children":[{"type":"CompoundType","label":"indexPattern","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":236,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L236"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.GetFieldsOptions","text":"GetFieldsOptions"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":237,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L237"}}],"signature":["(indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"},", options?: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.GetFieldsOptions","text":"GetFieldsOptions"}," | undefined) => Promise"],"description":["\nGet field list by providing an index patttern (or spec)"],"label":"getFieldsForIndexPattern","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":235,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L235"},"returnComment":["FieldSpec[]"]},{"id":"def-public.IndexPatternsService.refreshFields","type":"Function","children":[{"type":"Object","label":"indexPattern","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":250,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L250"}}],"signature":["(indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},") => Promise"],"description":["\nRefresh field list for a given index pattern"],"label":"refreshFields","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":250,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L250"},"returnComment":[]},{"id":"def-public.IndexPatternsService.fieldArrayToMap","type":"Function","children":[{"type":"Array","label":"fields","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},"[]"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":327,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L327"}},{"type":"Object","label":"fieldAttrs","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldAttrs","text":"FieldAttrs"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":327,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L327"}}],"signature":["(fields: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},"[], fieldAttrs?: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldAttrs","text":"FieldAttrs"}," | undefined) => Record"],"description":["\nConverts field array to map"],"label":"fieldArrayToMap","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":327,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L327"},"returnComment":["Record"]},{"id":"def-public.IndexPatternsService.savedObjectToSpec","type":"Function","children":[{"type":"Object","label":"savedObject","isRequired":true,"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},"<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternAttributes","text":"IndexPatternAttributes"},">"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":343,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L343"}}],"signature":["(savedObject: ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},"<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternAttributes","text":"IndexPatternAttributes"},">) => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"}],"description":["\nConverts index pattern saved object to index pattern spec"],"label":"savedObjectToSpec","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":343,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L343"},"returnComment":["IndexPatternSpec"]},{"id":"def-public.IndexPatternsService.get","type":"Function","children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":464,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L464"}}],"signature":["(id: string) => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},">"],"description":["\nGet an index pattern by id. Cache optimized"],"label":"get","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":464,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L464"},"returnComment":[]},{"id":"def-public.IndexPatternsService.create","type":"Function","label":"create","signature":["(spec: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"},", skipFetchFields?: boolean) => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},">"],"description":["\nCreate a new index pattern instance"],"children":[{"type":"Object","label":"spec","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":483,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L483"}},{"type":"boolean","label":"skipFetchFields","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":483,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L483"}}],"tags":[],"returnComment":["IndexPattern"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":483,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L483"}},{"id":"def-public.IndexPatternsService.createAndSave","type":"Function","label":"createAndSave","signature":["(spec: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"},", override?: boolean, skipFetchFields?: boolean) => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},">"],"description":["\nCreate a new index pattern and save it right away"],"children":[{"type":"Object","label":"spec","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":508,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508"}},{"type":"boolean","label":"override","isRequired":true,"signature":["boolean"],"description":["Overwrite if existing index pattern exists."],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":508,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508"}},{"type":"boolean","label":"skipFetchFields","isRequired":true,"signature":["boolean"],"description":["Whether to skip field refresh step."],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":508,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":508,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508"}},{"id":"def-public.IndexPatternsService.createSavedObject","type":"Function","label":"createSavedObject","signature":["(indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},", override?: boolean) => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},">"],"description":["\nSave a new index pattern"],"children":[{"type":"Object","label":"indexPattern","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":521,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L521"}},{"type":"boolean","label":"override","isRequired":true,"signature":["boolean"],"description":["Overwrite if existing index pattern exists"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":521,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L521"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":521,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L521"}},{"id":"def-public.IndexPatternsService.updateSavedObject","type":"Function","label":"updateSavedObject","signature":["(indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},", saveAttempts?: number, ignoreErrors?: boolean) => Promise"],"description":["\nSave existing index pattern. Will attempt to merge differences if there are conflicts"],"children":[{"type":"Object","label":"indexPattern","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":547,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L547"}},{"type":"number","label":"saveAttempts","isRequired":true,"signature":["number"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":548,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L548"}},{"type":"boolean","label":"ignoreErrors","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":549,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L549"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":546,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L546"}},{"id":"def-public.IndexPatternsService.delete","type":"Function","label":"delete","signature":["(indexPatternId: string) => Promise<{}>"],"description":["\nDeletes an index pattern from .kibana index"],"children":[{"type":"string","label":"indexPatternId","isRequired":true,"signature":["string"],"description":[": Id of kibana Index Pattern to delete"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":632,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L632"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":632,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L632"}}],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L57"},"initialIsOpen":false},{"id":"def-public.IndexPattern","type":"Class","label":"IndexPattern","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}," implements ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"}],"children":[{"id":"def-public.IndexPattern.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L45"},"signature":["string | undefined"]},{"id":"def-public.IndexPattern.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L46"}},{"id":"def-public.IndexPattern.fieldFormatMap","type":"Object","label":"fieldFormatMap","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L47"},"signature":["Record"]},{"id":"def-public.IndexPattern.typeMeta","type":"Object","label":"typeMeta","description":["\nOnly used by rollup indices, used by rollup specific endpoint to load field list"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L51"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.TypeMeta","text":"TypeMeta"}," | undefined"]},{"id":"def-public.IndexPattern.fields","type":"CompoundType","label":"fields","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L52"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPatternFieldList","text":"IIndexPatternFieldList"}," & { toSpec: () => Record; }"]},{"id":"def-public.IndexPattern.timeFieldName","type":"string","label":"timeFieldName","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L53"},"signature":["string | undefined"]},{"id":"def-public.IndexPattern.intervalName","type":"string","label":"intervalName","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L58"},"signature":["string | undefined"]},{"id":"def-public.IndexPattern.type","type":"string","label":"type","description":["\nType is used to identify rollup index patterns"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L62"},"signature":["string | undefined"]},{"id":"def-public.IndexPattern.formatHit","type":"Function","label":"formatHit","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L63"},"signature":["{ (hit: Record, type?: string | undefined): any; formatField: FormatFieldFn; }"]},{"id":"def-public.IndexPattern.formatField","type":"Function","label":"formatField","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L67"},"signature":["FormatFieldFn"]},{"id":"def-public.IndexPattern.flattenHit","type":"Function","label":"flattenHit","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L68"},"signature":["(hit: Record, deep?: boolean | undefined) => Record"]},{"id":"def-public.IndexPattern.metaFields","type":"Array","label":"metaFields","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L69"},"signature":["string[]"]},{"id":"def-public.IndexPattern.version","type":"string","label":"version","description":["\nSavedObject version"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L73"},"signature":["string | undefined"]},{"id":"def-public.IndexPattern.sourceFilters","type":"Array","label":"sourceFilters","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L74"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.SourceFilter","text":"SourceFilter"},"[] | undefined"]},{"id":"def-public.IndexPattern.allowNoIndex","type":"boolean","label":"allowNoIndex","description":["\nprevents errors when index pattern exists before indices"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L84"}},{"id":"def-public.IndexPattern.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"{\n spec = {},\n fieldFormats,\n shortDotsEnable = false,\n metaFields = [],\n }","isRequired":true,"signature":["IndexPatternDeps"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L86"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L86"}},{"id":"def-public.IndexPattern.getOriginalSavedObjectBody","type":"Function","children":[],"signature":["() => { fieldAttrs?: string | undefined; title?: string | undefined; timeFieldName?: string | undefined; intervalName?: string | undefined; fields?: string | undefined; sourceFilters?: string | undefined; fieldFormatMap?: string | undefined; typeMeta?: string | undefined; type?: string | undefined; }"],"description":["\nGet last saved saved object fields"],"label":"getOriginalSavedObjectBody","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":128,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L128"},"returnComment":[]},{"id":"def-public.IndexPattern.resetOriginalSavedObjectBody","type":"Function","children":[],"signature":["() => void"],"description":["\nReset last saved saved object fields. used after saving"],"label":"resetOriginalSavedObjectBody","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":133,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L133"},"returnComment":[]},{"id":"def-public.IndexPattern.getFieldAttrs","type":"Function","children":[],"signature":["() => { [x: string]: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldAttrSet","text":"FieldAttrSet"},"; }"],"description":[],"label":"getFieldAttrs","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":137,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L137"},"returnComment":[]},{"id":"def-public.IndexPattern.getComputedFields","type":"Function","label":"getComputedFields","signature":["() => { storedFields: string[]; scriptFields: any; docvalueFields: { field: any; format: string; }[]; runtimeFields: Record; }"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":162,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L162"}},{"id":"def-public.IndexPattern.toSpec","type":"Function","label":"toSpec","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"}],"description":["\nCreate static representation of index pattern"],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":208,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L208"}},{"id":"def-public.IndexPattern.getSourceFiltering","type":"Function","label":"getSourceFiltering","signature":["() => { excludes: any[]; }"],"description":["\nGet the source filtering configuration for that index."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":230,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L230"}},{"id":"def-public.IndexPattern.addScriptedField","type":"Function","label":"addScriptedField","signature":["(name: string, script: string, fieldType?: string) => Promise"],"description":["\nAdd scripted field to field list\n"],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":["field name"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":244,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L244"}},{"type":"string","label":"script","isRequired":true,"signature":["string"],"description":["script code"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":244,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L244"}},{"type":"string","label":"fieldType","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":244,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L244"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":244,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L244"}},{"id":"def-public.IndexPattern.removeScriptedField","type":"Function","label":"removeScriptedField","signature":["(fieldName: string) => void"],"description":["\nRemove scripted field from field list"],"children":[{"type":"string","label":"fieldName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":270,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L270"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":270,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L270"}},{"id":"def-public.IndexPattern.getNonScriptedFields","type":"Function","label":"getNonScriptedFields","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":277,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L277"}},{"id":"def-public.IndexPattern.getScriptedFields","type":"Function","label":"getScriptedFields","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":281,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L281"}},{"id":"def-public.IndexPattern.isTimeBased","type":"Function","label":"isTimeBased","signature":["() => boolean"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":285,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L285"}},{"id":"def-public.IndexPattern.isTimeNanosBased","type":"Function","label":"isTimeNanosBased","signature":["() => boolean"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":289,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L289"}},{"id":"def-public.IndexPattern.getTimeField","type":"Function","label":"getTimeField","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"}," | undefined"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":294,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L294"}},{"id":"def-public.IndexPattern.getFieldByName","type":"Function","label":"getFieldByName","signature":["(name: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"}," | undefined"],"description":[],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":299,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L299"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":299,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L299"}},{"id":"def-public.IndexPattern.getAggregationRestrictions","type":"Function","label":"getAggregationRestrictions","signature":["() => Record> | undefined"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":304,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L304"}},{"id":"def-public.IndexPattern.getAsSavedObjectBody","type":"Function","label":"getAsSavedObjectBody","signature":["() => { fieldAttrs: string | undefined; title: string; timeFieldName: string | undefined; intervalName: string | undefined; sourceFilters: string | undefined; fields: string | undefined; fieldFormatMap: string | undefined; type: string | undefined; typeMeta: string | undefined; allowNoIndex: true | undefined; runtimeFieldMap: string | undefined; }"],"description":["\nReturns index pattern as saved object body for saving"],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":311,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L311"}},{"id":"def-public.IndexPattern.getFormatterForField","type":"Function","label":"getFormatterForField","signature":["(field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"}],"description":["\nProvide a field, get its formatter"],"children":[{"type":"CompoundType","label":"field","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":340,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L340"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":339,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L339"}},{"id":"def-public.IndexPattern.addRuntimeField","type":"Function","label":"addRuntimeField","signature":["(name: string, runtimeField: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.RuntimeField","text":"RuntimeField"},") => void"],"description":["\nAdd a runtime field - Appended to existing mapped field or a new field is\ncreated as appropriate"],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":["Field name"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":360,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L360"}},{"type":"Object","label":"runtimeField","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.RuntimeField","text":"RuntimeField"}],"description":["Runtime field definition"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":360,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L360"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":360,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L360"}},{"id":"def-public.IndexPattern.removeRuntimeField","type":"Function","label":"removeRuntimeField","signature":["(name: string) => void"],"description":["\nRemove a runtime field - removed from mapped field or removed unmapped\nfield as appropriate"],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":["Field name"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":384,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L384"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":384,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L384"}},{"id":"def-public.IndexPattern.getFormatterForFieldNoDefault","type":"Function","label":"getFormatterForFieldNoDefault","signature":["(fieldname: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"}," | undefined"],"description":["\nGet formatter for a given field name. Return undefined if none exists"],"children":[{"type":"string","label":"fieldname","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":404,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L404"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":404,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L404"}},{"id":"def-public.IndexPattern.setFieldAttrs","type":"Function","label":"setFieldAttrs","signature":["(fieldName: string, attrName: K, value: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldAttrSet","text":"FieldAttrSet"},"[K]) => void"],"description":[],"children":[{"type":"string","label":"fieldName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":412,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L412"}},{"type":"Uncategorized","label":"attrName","isRequired":true,"signature":["K"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":413,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L413"}},{"type":"Uncategorized","label":"value","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldAttrSet","text":"FieldAttrSet"},"[K]"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":414,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L414"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":411,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L411"}},{"id":"def-public.IndexPattern.setFieldCustomLabel","type":"Function","label":"setFieldCustomLabel","signature":["(fieldName: string, customLabel: string | null | undefined) => void"],"description":[],"children":[{"type":"string","label":"fieldName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":422,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L422"}},{"type":"CompoundType","label":"customLabel","isRequired":false,"signature":["string | null | undefined"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":422,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L422"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":422,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L422"}},{"id":"def-public.IndexPattern.setFieldCount","type":"Function","label":"setFieldCount","signature":["(fieldName: string, count: number | null | undefined) => void"],"description":[],"children":[{"type":"string","label":"fieldName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":433,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L433"}},{"type":"CompoundType","label":"count","isRequired":false,"signature":["number | null | undefined"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":433,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L433"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":433,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L433"}},{"id":"def-public.IndexPattern.setFieldFormat","type":"Function","children":[{"type":"string","label":"fieldName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":446,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L446"}},{"type":"Object","label":"format","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializedFieldFormat","text":"SerializedFieldFormat"},">"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":446,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L446"}}],"signature":["(fieldName: string, format: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializedFieldFormat","text":"SerializedFieldFormat"},">) => void"],"description":[],"label":"setFieldFormat","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":446,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L446"},"returnComment":[]},{"id":"def-public.IndexPattern.deleteFieldFormat","type":"Function","children":[{"type":"string","label":"fieldName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":450,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L450"}}],"signature":["(fieldName: string) => void"],"description":[],"label":"deleteFieldFormat","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":450,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L450"},"returnComment":[]}],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L44"},"initialIsOpen":false},{"id":"def-public.IndexPatternField","type":"Class","label":"IndexPatternField","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"}," implements ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}],"children":[{"id":"def-public.IndexPatternField.spec","type":"Object","label":"spec","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L17"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"}]},{"id":"def-public.IndexPatternField.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"spec","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L21"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L21"}},{"id":"def-public.IndexPatternField.count","type":"number","label":"count","description":["\nCount is used for field popularity"],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L31"}},{"id":"def-public.IndexPatternField.count","type":"number","label":"count","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L35"}},{"id":"def-public.IndexPatternField.runtimeField","type":"Object","label":"runtimeField","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L39"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.RuntimeField","text":"RuntimeField"}," | undefined"]},{"id":"def-public.IndexPatternField.runtimeField","type":"Object","label":"runtimeField","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L43"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.RuntimeField","text":"RuntimeField"}," | undefined"]},{"id":"def-public.IndexPatternField.script","type":"string","label":"script","description":["\nScript field code"],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L50"},"signature":["string | undefined"]},{"id":"def-public.IndexPatternField.script","type":"string","label":"script","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L54"},"signature":["string | undefined"]},{"id":"def-public.IndexPatternField.lang","type":"string","label":"lang","description":["\nScript field language"],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L61"},"signature":["string | undefined"]},{"id":"def-public.IndexPatternField.lang","type":"string","label":"lang","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L65"},"signature":["string | undefined"]},{"id":"def-public.IndexPatternField.customLabel","type":"string","label":"customLabel","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L69"},"signature":["string | undefined"]},{"id":"def-public.IndexPatternField.customLabel","type":"string","label":"customLabel","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L73"},"signature":["string | undefined"]},{"id":"def-public.IndexPatternField.conflictDescriptions","type":"Object","label":"conflictDescriptions","description":["\nDescription of field type conflicts across different indices in the same index pattern"],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L80"},"signature":["Record | undefined"]},{"id":"def-public.IndexPatternField.conflictDescriptions","type":"Object","label":"conflictDescriptions","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L84"},"signature":["Record | undefined"]},{"id":"def-public.IndexPatternField.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L89"}},{"id":"def-public.IndexPatternField.displayName","type":"string","label":"displayName","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":93,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L93"}},{"id":"def-public.IndexPatternField.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L101"}},{"id":"def-public.IndexPatternField.esTypes","type":"Array","label":"esTypes","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":107,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L107"},"signature":["string[] | undefined"]},{"id":"def-public.IndexPatternField.scripted","type":"boolean","label":"scripted","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":111,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L111"}},{"id":"def-public.IndexPatternField.searchable","type":"boolean","label":"searchable","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L115"}},{"id":"def-public.IndexPatternField.aggregatable","type":"boolean","label":"aggregatable","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":119,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L119"}},{"id":"def-public.IndexPatternField.readFromDocValues","type":"boolean","label":"readFromDocValues","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":123,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L123"}},{"id":"def-public.IndexPatternField.subType","type":"Object","label":"subType","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":127,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L127"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldSubType","text":"IFieldSubType"}," | undefined"]},{"id":"def-public.IndexPatternField.isMapped","type":"CompoundType","label":"isMapped","description":["\nIs the field part of the index mapping?"],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":134,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L134"},"signature":["boolean | undefined"]},{"id":"def-public.IndexPatternField.sortable","type":"boolean","label":"sortable","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":139,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L139"}},{"id":"def-public.IndexPatternField.filterable","type":"boolean","label":"filterable","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":146,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L146"}},{"id":"def-public.IndexPatternField.visualizable","type":"boolean","label":"visualizable","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":154,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L154"}},{"id":"def-public.IndexPatternField.deleteCount","type":"Function","label":"deleteCount","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":159,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L159"}},{"id":"def-public.IndexPatternField.toJSON","type":"Function","label":"toJSON","signature":["() => { count: number; script: string | undefined; lang: string | undefined; conflictDescriptions: Record | undefined; name: string; type: string; esTypes: string[] | undefined; scripted: boolean; searchable: boolean; aggregatable: boolean; readFromDocValues: boolean; subType: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldSubType","text":"IFieldSubType"}," | undefined; customLabel: string | undefined; }"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":163,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L163"}},{"id":"def-public.IndexPatternField.toSpec","type":"Function","label":"toSpec","signature":["({ getFormatterForField, }?: { getFormatterForField?: ((field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"},") | undefined; }) => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"}],"description":[],"children":[{"id":"def-public.IndexPatternField.toSpec.{\n- getFormatterForField,\n }","type":"Object","label":"{\n getFormatterForField,\n }","description":[],"children":[{"id":"def-public.IndexPatternField.toSpec.{\n- getFormatterForField,\n }.getFormatterForField","type":"Function","label":"getFormatterForField","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":184,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L184"},"signature":["((field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"},") | undefined"]}],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":183,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L183"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":181,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L181"}}],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L16"},"initialIsOpen":false},{"id":"def-public.DuplicateIndexPatternError","type":"Class","label":"DuplicateIndexPatternError","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.DuplicateIndexPatternError","text":"DuplicateIndexPatternError"}," extends Error"],"children":[{"id":"def-public.DuplicateIndexPatternError.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"string","label":"message","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts#L10"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts#L10"}}],"source":{"path":"src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts#L9"},"initialIsOpen":false},{"id":"def-public.AggParamType","type":"Class","label":"AggParamType","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamType","text":"AggParamType"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseParamType","text":"BaseParamType"},""],"children":[{"id":"def-public.AggParamType.makeAgg","type":"Function","label":"makeAgg","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/agg.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/agg.ts#L15"},"signature":["(agg: TAggConfig, state?: { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined; schema?: string | undefined; } | undefined) => TAggConfig"]},{"id":"def-public.AggParamType.allowedAggs","type":"Array","label":"allowedAggs","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/agg.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/agg.ts#L16"},"signature":["string[]"]},{"id":"def-public.AggParamType.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"config","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/agg.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/agg.ts#L18"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/agg.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/agg.ts#L18"}}],"source":{"path":"src/plugins/data/common/search/aggs/param_types/agg.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/agg.ts#L12"},"initialIsOpen":false},{"id":"def-public.OptionedParamType","type":"Class","label":"OptionedParamType","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.OptionedParamType","text":"OptionedParamType"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseParamType","text":"BaseParamType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},">"],"children":[{"id":"def-public.OptionedParamType.options","type":"Array","label":"options","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/optioned.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L20"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.OptionedValueProp","text":"OptionedValueProp"},"[]"]},{"id":"def-public.OptionedParamType.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"config","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/optioned.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L22"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/optioned.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L22"}}],"source":{"path":"src/plugins/data/common/search/aggs/param_types/optioned.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L19"},"initialIsOpen":false},{"id":"def-public.AggConfigs","type":"Class","label":"AggConfigs","description":[],"children":[{"id":"def-public.AggConfigs.indexPattern","type":"Object","label":"indexPattern","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L58"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}]},{"id":"def-public.AggConfigs.timeRange","type":"Object","label":"timeRange","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L59"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"}," | undefined"]},{"id":"def-public.AggConfigs.aggs","type":"Array","label":"aggs","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L62"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},"[]"]},{"id":"def-public.AggConfigs.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"indexPattern","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L65"}},{"type":"Array","label":"configStates","isRequired":true,"signature":["Pick & Pick<{ type: string | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IAggType","text":"IAggType"},"; }, \"type\"> & Pick<{ type: string | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IAggType","text":"IAggType"},"; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[]"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L66"}},{"type":"Object","label":"opts","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfigsOptions","text":"AggConfigsOptions"}],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L67"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L64"}},{"id":"def-public.AggConfigs.setTimeRange","type":"Function","label":"setTimeRange","signature":["(timeRange: ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"},") => void"],"description":[],"children":[{"type":"Object","label":"timeRange","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"}],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L79"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L79"}},{"id":"def-public.AggConfigs.clone","type":"Function","label":"clone","signature":["({ enabledOnly }?: { enabledOnly?: boolean | undefined; }) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfigs","text":"AggConfigs"}],"description":[],"children":[{"type":"Object","label":"{ enabledOnly = true }","isRequired":true,"signature":["{ enabledOnly?: boolean | undefined; }"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L97"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L97"}},{"id":"def-public.AggConfigs.createAggConfig","type":"Function","children":[{"type":"Object","label":"params","isRequired":true,"signature":["Pick & Pick<{ type: string | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IAggType","text":"IAggType"},"; }, \"type\"> & Pick<{ type: string | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IAggType","text":"IAggType"},"; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":111,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L111"}},{"type":"Object","label":"{ addToAggConfigs = true }","isRequired":true,"signature":["{ addToAggConfigs?: boolean | undefined; }"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":112,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L112"}}],"signature":["(params: Pick & Pick<{ type: string | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IAggType","text":"IAggType"},"; }, \"type\"> & Pick<{ type: string | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IAggType","text":"IAggType"}],"description":[],"label":"createAggConfig","source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L110"},"returnComment":[]},{"id":"def-public.AggConfigs.jsonDataEquals","type":"Function","label":"jsonDataEquals","signature":["(aggConfigs: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},"[]) => boolean"],"description":["\nData-by-data comparison of this Aggregation\nIgnores the non-array indexes"],"children":[{"type":"Array","label":"aggConfigs","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},"[]"],"description":["an AggConfigs instance"],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":153,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L153"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":153,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L153"}},{"id":"def-public.AggConfigs.toDsl","type":"Function","label":"toDsl","signature":["(hierarchical?: boolean) => Record"],"description":[],"children":[{"type":"boolean","label":"hierarchical","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":165,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L165"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":165,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L165"}},{"id":"def-public.AggConfigs.getAll","type":"Function","label":"getAll","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":227,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L227"}},{"id":"def-public.AggConfigs.byIndex","type":"Function","label":"byIndex","signature":["(index: number) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"}],"description":[],"children":[{"type":"number","label":"index","isRequired":true,"signature":["number"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":231,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L231"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":231,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L231"}},{"id":"def-public.AggConfigs.byId","type":"Function","label":"byId","signature":["(id: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"}," | undefined"],"description":[],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":235,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L235"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":235,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L235"}},{"id":"def-public.AggConfigs.byName","type":"Function","label":"byName","signature":["(name: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},"[]"],"description":[],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":239,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L239"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":239,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L239"}},{"id":"def-public.AggConfigs.byType","type":"Function","label":"byType","signature":["(type: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},"[]"],"description":[],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":243,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L243"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":243,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L243"}},{"id":"def-public.AggConfigs.byTypeName","type":"Function","label":"byTypeName","signature":["(type: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},"[]"],"description":[],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":247,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L247"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":247,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L247"}},{"id":"def-public.AggConfigs.bySchemaName","type":"Function","label":"bySchemaName","signature":["(schema: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},"[]"],"description":[],"children":[{"type":"string","label":"schema","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":251,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L251"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":251,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L251"}},{"id":"def-public.AggConfigs.getRequestAggs","type":"Function","label":"getRequestAggs","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":255,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L255"}},{"id":"def-public.AggConfigs.getRequestAggById","type":"Function","label":"getRequestAggById","signature":["(id: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"}," | undefined"],"description":[],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":269,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L269"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":269,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L269"}},{"id":"def-public.AggConfigs.getResponseAggs","type":"Function","label":"getResponseAggs","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},"[]"],"description":["\nGets the AggConfigs (and possibly ResponseAggConfigs) that\nrepresent the values that will be produced when all aggs\nare run.\n\nWith multi-value metric aggs it is possible for a single agg\nrequest to result in multiple agg values, which is why the length\nof a vis' responseValuesAggs may be different than the vis' aggs\n"],"children":[],"tags":["return"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":284,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L284"}},{"id":"def-public.AggConfigs.getResponseAggById","type":"Function","label":"getResponseAggById","signature":["(id: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"}," | undefined"],"description":["\nFind a response agg by it's id. This may be an agg in the aggConfigs, or one\ncreated specifically for a response value\n"],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":["- the id of the agg to find"],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":298,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L298"}}],"tags":["return"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":298,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L298"}},{"id":"def-public.AggConfigs.onSearchRequestStart","type":"Function","label":"onSearchRequestStart","signature":["(searchSource: Pick<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"},", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">, options?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"}," | undefined) => Promise<[unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown]>"],"description":[],"children":[{"type":"Object","label":"searchSource","isRequired":true,"signature":["Pick<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"},", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":307,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L307"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":307,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L307"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":307,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L307"}}],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L57"},"initialIsOpen":false},{"id":"def-public.AggConfig","type":"Class","label":"AggConfig","description":[],"children":[{"id":"def-public.AggConfig.ensureIds","type":"Function","label":"ensureIds","signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},".ensureIds"],"description":["\nEnsure that all of the objects in the list have ids, the objects\nand list are modified by reference.\n"],"children":[{"type":"Array","label":"list","isRequired":true,"signature":["any[]"],"description":["- a list of objects, objects can be anything really"],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L63"}}],"tags":["return"],"returnComment":["- the list that was passed in"],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L63"}},{"id":"def-public.AggConfig.nextId","type":"Function","label":"nextId","signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},".nextId"],"description":["\nCalculate the next id based on the ids in this list\n"],"children":[{"type":"Array","label":"list","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},"[]"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L83"}}],"tags":["return"],"returnComment":["list - a list of objects with id properties"],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L83"}},{"id":"def-public.AggConfig.aggConfigs","type":"Object","label":"aggConfigs","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L92"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfigs","text":"AggConfigs"}]},{"id":"def-public.AggConfig.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":93,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L93"}},{"id":"def-public.AggConfig.enabled","type":"boolean","label":"enabled","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L94"}},{"id":"def-public.AggConfig.params","type":"Any","label":"params","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L95"},"signature":["any"]},{"id":"def-public.AggConfig.parent","type":"Object","label":"parent","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L96"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfigs","text":"AggConfigs"}," | undefined"]},{"id":"def-public.AggConfig.brandNew","type":"CompoundType","label":"brandNew","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L97"},"signature":["boolean | undefined"]},{"id":"def-public.AggConfig.schema","type":"string","label":"schema","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L98"},"signature":["string | undefined"]},{"id":"def-public.AggConfig.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"aggConfigs","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfigs","text":"AggConfigs"}],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L104"}},{"type":"Object","label":"opts","isRequired":true,"signature":["Pick & Pick<{ type: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IAggType","text":"IAggType"},"; }, \"type\"> & Pick<{ type: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IAggType","text":"IAggType"},"; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L104"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L104"}},{"id":"def-public.AggConfig.setParams","type":"Function","label":"setParams","signature":["(from: any) => void"],"description":["\nWrite the current values to this.params, filling in the defaults as we go\n"],"children":[{"type":"Any","label":"from","isRequired":true,"signature":["any"],"description":["- optional object to read values from,\n used when initializing"],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":134,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L134"}}],"tags":["return"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":134,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L134"}},{"id":"def-public.AggConfig.getParam","type":"Function","label":"getParam","signature":["(key: string) => any"],"description":[],"children":[{"type":"string","label":"key","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":171,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L171"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":171,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L171"}},{"id":"def-public.AggConfig.write","type":"Function","label":"write","signature":["(aggs?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfigs","text":"AggConfigs"}," | undefined) => Record"],"description":[],"children":[{"type":"Object","label":"aggs","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfigs","text":"AggConfigs"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":175,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L175"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":175,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L175"}},{"id":"def-public.AggConfig.isFilterable","type":"Function","label":"isFilterable","signature":["() => boolean"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":179,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L179"}},{"id":"def-public.AggConfig.createFilter","type":"Function","label":"createFilter","signature":["(key: string, params?: {}) => any"],"description":[],"children":[{"type":"string","label":"key","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":183,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L183"}},{"type":"Object","label":"params","isRequired":true,"signature":["{}"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":183,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L183"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":183,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L183"}},{"id":"def-public.AggConfig.onSearchRequestStart","type":"Function","label":"onSearchRequestStart","signature":["(searchSource: Pick<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"},", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">, options?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"}," | undefined) => Promise | Promise"],"description":["\n Hook for pre-flight logic, see AggType#onSearchRequestStart"],"children":[{"type":"Object","label":"searchSource","isRequired":true,"signature":["Pick<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"},", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":209,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L209"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":209,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L209"}}],"tags":["return"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":209,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L209"}},{"id":"def-public.AggConfig.toDsl","type":"Function","label":"toDsl","signature":["(aggConfigs?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfigs","text":"AggConfigs"}," | undefined) => any"],"description":["\nConvert this aggConfig to its dsl syntax.\n\nAdds params and adhoc subaggs to a pojo, then returns it\n"],"children":[{"type":"Object","label":"aggConfigs","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfigs","text":"AggConfigs"}," | undefined"],"description":["- the config object to convert"],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":230,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L230"}}],"tags":["return"],"returnComment":["- if the config has a dsl representation, it is\n returned, else undefined is returned"],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":230,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L230"}},{"id":"def-public.AggConfig.serialize","type":"Function","label":"serialize","signature":["() => { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined; schema?: string | undefined; }"],"description":[],"children":[],"tags":[],"returnComment":["Returns a serialized representation of an AggConfig."],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":259,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L259"}},{"id":"def-public.AggConfig.toJSON","type":"Function","label":"toJSON","signature":["() => { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined; schema?: string | undefined; }"],"description":[],"children":[],"tags":["deprecated"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":290,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L290"}},{"id":"def-public.AggConfig.toSerializedFieldFormat","type":"Function","label":"toSerializedFieldFormat","signature":["() => {}"],"description":["\nReturns a serialized field format for the field used in this agg.\nThis can be passed to fieldFormats.deserialize to get the field\nformat instance.\n"],"children":[],"tags":["public"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":301,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L301"}},{"id":"def-public.AggConfig.toExpressionAst","type":"Function","label":"toExpressionAst","signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}," | undefined"],"description":[],"children":[],"tags":[],"returnComment":["Returns an ExpressionAst representing the this agg type."],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":310,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L310"}},{"id":"def-public.AggConfig.getAggParams","type":"Function","label":"getAggParams","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamType","text":"AggParamType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},">[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":365,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L365"}},{"id":"def-public.AggConfig.getRequestAggs","type":"Function","label":"getRequestAggs","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":369,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L369"}},{"id":"def-public.AggConfig.getResponseAggs","type":"Function","label":"getResponseAggs","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":373,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L373"}},{"id":"def-public.AggConfig.getValue","type":"Function","label":"getValue","signature":["(bucket: any) => any"],"description":[],"children":[{"type":"Any","label":"bucket","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":377,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L377"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":377,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L377"}},{"id":"def-public.AggConfig.getKey","type":"Function","label":"getKey","signature":["(bucket: any, key?: string | undefined) => any"],"description":[],"children":[{"type":"Any","label":"bucket","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":381,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L381"}},{"type":"string","label":"key","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":381,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L381"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":381,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L381"}},{"id":"def-public.AggConfig.getFieldDisplayName","type":"Function","label":"getFieldDisplayName","signature":["() => any"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":389,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L389"}},{"id":"def-public.AggConfig.getField","type":"Function","label":"getField","signature":["() => any"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":395,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L395"}},{"id":"def-public.AggConfig.getValueBucketPath","type":"Function","label":"getValueBucketPath","signature":["() => string"],"description":["\nReturns the bucket path containing the main value the agg will produce\n(e.g. for sum of bytes it will point to the sum, for median it will point\n to the 50 percentile in the percentile multi value bucket)"],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":404,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L404"}},{"id":"def-public.AggConfig.makeLabel","type":"Function","label":"makeLabel","signature":["(percentageMode?: boolean) => any"],"description":[],"children":[{"type":"boolean","label":"percentageMode","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":408,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L408"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":408,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L408"}},{"id":"def-public.AggConfig.getIndexPattern","type":"Function","label":"getIndexPattern","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":422,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L422"}},{"id":"def-public.AggConfig.getTimeRange","type":"Function","label":"getTimeRange","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"}," | undefined"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":426,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L426"}},{"id":"def-public.AggConfig.fieldName","type":"Function","label":"fieldName","signature":["() => any"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":430,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L430"}},{"id":"def-public.AggConfig.fieldIsTimeField","type":"Function","label":"fieldIsTimeField","signature":["() => boolean | \"\" | undefined"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":435,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L435"}},{"id":"def-public.AggConfig.type","type":"Object","label":"type","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":442,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L442"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IAggType","text":"IAggType"}]},{"id":"def-public.AggConfig.type","type":"Object","label":"type","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":446,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L446"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IAggType","text":"IAggType"}]},{"id":"def-public.AggConfig.setType","type":"Function","label":"setType","signature":["(type: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IAggType","text":"IAggType"},") => void"],"description":[],"children":[{"type":"Object","label":"type","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IAggType","text":"IAggType"}],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":476,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L476"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":476,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L476"}}],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L55"},"initialIsOpen":false},{"id":"def-public.SearchSource","type":"Class","label":"SearchSource","description":[],"children":[{"id":"def-public.SearchSource.history","type":"Array","label":"history","description":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":112,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L112"},"signature":["Record[]"]},{"id":"def-public.SearchSource.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"fields","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"}],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L116"}},{"type":"Object","label":"dependencies","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceDependencies","text":"SearchSourceDependencies"}],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L116"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L116"}},{"id":"def-public.SearchSource.setPreferredSearchStrategyId","type":"Function","label":"setPreferredSearchStrategyId","signature":["(searchStrategyId: string) => void"],"description":["**\nPUBLIC API\n\ninternal, dont use"],"children":[{"type":"string","label":"searchStrategyId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":134,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L134"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":134,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L134"}},{"id":"def-public.SearchSource.setField","type":"Function","label":"setField","signature":["(field: K, value: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"},"[K]) => this"],"description":["\nsets value to a single search source field"],"children":[{"type":"Uncategorized","label":"field","isRequired":true,"signature":["K"],"description":[": field name"],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":143,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L143"}},{"type":"Uncategorized","label":"value","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"},"[K]"],"description":[": value for the field"],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":143,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L143"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":143,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L143"}},{"id":"def-public.SearchSource.removeField","type":"Function","label":"removeField","signature":["(field: K) => this"],"description":["\nremove field"],"children":[{"type":"Uncategorized","label":"field","isRequired":true,"signature":["K"],"description":[": field name"],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":155,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L155"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":155,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L155"}},{"id":"def-public.SearchSource.setFields","type":"Function","label":"setFields","signature":["(newFields: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"},") => this"],"description":["\nInternal, do not use. Overrides all search source fields with the new field array.\n"],"children":[{"type":"Object","label":"newFields","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"}],"description":["New field array."],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":166,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L166"}}],"tags":["private"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":166,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L166"}},{"id":"def-public.SearchSource.getId","type":"Function","label":"getId","signature":["() => string"],"description":["\nreturns search source id"],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":174,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L174"}},{"id":"def-public.SearchSource.getFields","type":"Function","label":"getFields","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"}],"description":["\nreturns all search source fields"],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":181,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L181"}},{"id":"def-public.SearchSource.getField","type":"Function","label":"getField","signature":["(field: K, recurse?: boolean) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"},"[K]"],"description":["\nGets a single field from the fields"],"children":[{"type":"Uncategorized","label":"field","isRequired":true,"signature":["K"],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":188,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L188"}},{"type":"boolean","label":"recurse","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":188,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L188"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":188,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L188"}},{"id":"def-public.SearchSource.getOwnField","type":"Function","label":"getOwnField","signature":["(field: K) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"},"[K]"],"description":["\nGet the field from our own fields, don't traverse up the chain"],"children":[{"type":"Uncategorized","label":"field","isRequired":true,"signature":["K"],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":199,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L199"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":199,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L199"}},{"id":"def-public.SearchSource.create","type":"Function","label":"create","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"}],"description":[],"children":[],"tags":["deprecated"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":206,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L206"}},{"id":"def-public.SearchSource.createCopy","type":"Function","label":"createCopy","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"}],"description":["\ncreates a copy of this search source (without its children)"],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":213,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L213"}},{"id":"def-public.SearchSource.createChild","type":"Function","label":"createChild","signature":["(options?: {}) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"}],"description":["\ncreates a new child search source"],"children":[{"type":"Object","label":"options","isRequired":true,"signature":["{}"],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":227,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L227"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":227,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L227"}},{"id":"def-public.SearchSource.setParent","type":"Function","label":"setParent","signature":["(parent?: Pick<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"},", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined, options?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceOptions","text":"SearchSourceOptions"},") => this"],"description":["\nSet a searchSource that this source should inherit from"],"children":[{"type":"Object","label":"parent","isRequired":false,"signature":["Pick<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"},", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined"],"description":["- the parent searchSource"],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":239,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L239"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceOptions","text":"SearchSourceOptions"}],"description":["- the inherit options"],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":239,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L239"}}],"tags":["return"],"returnComment":["- chainable"],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":239,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L239"}},{"id":"def-public.SearchSource.getParent","type":"Function","label":"getParent","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"}," | undefined"],"description":["\nGet the parent of this SearchSource"],"children":[],"tags":["return"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":249,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L249"}},{"id":"def-public.SearchSource.fetch$","type":"Function","label":"fetch$","signature":["(options?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"},") => ","Observable","<","SearchResponse",">"],"description":["\nFetch this source from Elasticsearch, returning an observable over the response(s)"],"children":[{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"}],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":257,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L257"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":257,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L257"}},{"id":"def-public.SearchSource.fetch","type":"Function","label":"fetch","signature":["(options?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"},") => Promise<","SearchResponse",">"],"description":["\nFetch this source and reject the returned Promise on error"],"children":[{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"}],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":284,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L284"}}],"tags":["deprecated"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":284,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L284"}},{"id":"def-public.SearchSource.onRequestStart","type":"Function","label":"onRequestStart","signature":["(handler: (searchSource: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"},", options?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"}," | undefined) => Promise) => void"],"description":["\n Add a handler that will be notified whenever requests start"],"children":[{"type":"Function","label":"handler","isRequired":true,"signature":["(searchSource: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"},", options?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"}," | undefined) => Promise"],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":294,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L294"}}],"tags":["return"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":293,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L293"}},{"id":"def-public.SearchSource.getSearchRequestBody","type":"Function","label":"getSearchRequestBody","signature":["() => Promise"],"description":["\nReturns body contents of the search request, often referred as query DSL."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":302,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L302"}},{"id":"def-public.SearchSource.destroy","type":"Function","label":"destroy","signature":["() => void"],"description":["\nCompletely destroy the SearchSource."],"children":[],"tags":["return"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":311,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L311"}},{"id":"def-public.SearchSource.getSerializedFields","type":"Function","label":"getSerializedFields","signature":["(recurse?: boolean) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"}],"description":["\nserializes search source fields (which can later be passed to {@link ISearchStartSearchSource})"],"children":[{"type":"boolean","label":"recurse","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":689,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L689"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":689,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L689"}},{"id":"def-public.SearchSource.serialize","type":"Function","label":"serialize","signature":["() => { searchSourceJSON: string; references: ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[]; }"],"description":["\nSerializes the instance to a JSON string and a set of referenced objects.\nUse this method to get a representation of the search source which can be stored in a saved object.\n\nThe references returned by this function can be mixed with other references in the same object,\nhowever make sure there are no name-collisions. The references will be named `kibanaSavedObjectMeta.searchSourceJSON.index`\nand `kibanaSavedObjectMeta.searchSourceJSON.filter[].meta.index`.\n\nUsing `createSearchSource`, the instance can be re-created."],"children":[],"tags":["public"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":718,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L718"}}],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L104"},"initialIsOpen":false},{"id":"def-public.DataPublicPlugin","type":"Class","label":"DataPublicPlugin","description":[],"signature":[{"pluginId":"data","scope":"public","docId":"kibDataPluginApi","section":"def-public.DataPublicPlugin","text":"DataPublicPlugin"}," implements ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Plugin","text":"Plugin"},"<",{"pluginId":"data","scope":"public","docId":"kibDataPluginApi","section":"def-public.DataPublicPluginSetup","text":"DataPublicPluginSetup"},", ",{"pluginId":"data","scope":"public","docId":"kibDataPluginApi","section":"def-public.DataPublicPluginStart","text":"DataPublicPluginStart"},", ","DataSetupDependencies"],"children":[{"id":"def-public.DataPublicPlugin.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"initializerContext","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.PluginInitializerContext","text":"PluginInitializerContext"},"; }>; }>; autocomplete: Readonly<{} & { querySuggestions: Readonly<{} & { enabled: boolean; }>; valueSuggestions: Readonly<{} & { enabled: boolean; }>; }>; }>>"],"description":[],"source":{"path":"src/plugins/data/public/plugin.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/plugin.ts#L71"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/plugin.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/plugin.ts#L71"}},{"id":"def-public.DataPublicPlugin.setup","type":"Function","label":"setup","signature":["(core: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreSetup","text":"CoreSetup"},"<",{"pluginId":"data","scope":"public","docId":"kibDataPluginApi","section":"def-public.DataStartDependencies","text":"DataStartDependencies"},", ",{"pluginId":"data","scope":"public","docId":"kibDataPluginApi","section":"def-public.DataPublicPluginStart","text":"DataPublicPluginStart"},">, { bfetch, expressions, uiActions, usageCollection, inspector }: ",{"pluginId":"data","scope":"public","docId":"kibDataPluginApi","section":"def-public.DataSetupDependencies","text":"DataSetupDependencies"},") => ",{"pluginId":"data","scope":"public","docId":"kibDataPluginApi","section":"def-public.DataPublicPluginSetup","text":"DataPublicPluginSetup"}],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreSetup","text":"CoreSetup"},"<",{"pluginId":"data","scope":"public","docId":"kibDataPluginApi","section":"def-public.DataStartDependencies","text":"DataStartDependencies"},", ",{"pluginId":"data","scope":"public","docId":"kibDataPluginApi","section":"def-public.DataPublicPluginStart","text":"DataPublicPluginStart"},">"],"description":[],"source":{"path":"src/plugins/data/public/plugin.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/plugin.ts#L81"}},{"type":"Object","label":"{ bfetch, expressions, uiActions, usageCollection, inspector }","isRequired":true,"signature":[{"pluginId":"data","scope":"public","docId":"kibDataPluginApi","section":"def-public.DataSetupDependencies","text":"DataSetupDependencies"}],"description":[],"source":{"path":"src/plugins/data/public/plugin.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/plugin.ts#L82"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/plugin.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/plugin.ts#L80"}},{"id":"def-public.DataPublicPlugin.start","type":"Function","label":"start","signature":["(core: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreStart","text":"CoreStart"},", { uiActions }: ",{"pluginId":"data","scope":"public","docId":"kibDataPluginApi","section":"def-public.DataStartDependencies","text":"DataStartDependencies"},") => ",{"pluginId":"data","scope":"public","docId":"kibDataPluginApi","section":"def-public.DataPublicPluginStart","text":"DataPublicPluginStart"}],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreStart","text":"CoreStart"}],"description":[],"source":{"path":"src/plugins/data/public/plugin.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/plugin.ts#L131"}},{"type":"Object","label":"{ uiActions }","isRequired":true,"signature":[{"pluginId":"data","scope":"public","docId":"kibDataPluginApi","section":"def-public.DataStartDependencies","text":"DataStartDependencies"}],"description":[],"source":{"path":"src/plugins/data/public/plugin.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/plugin.ts#L131"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/plugin.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/plugin.ts#L131"}},{"id":"def-public.DataPublicPlugin.stop","type":"Function","label":"stop","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/plugin.ts","lineNumber":213,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/plugin.ts#L213"}}],"source":{"path":"src/plugins/data/public/plugin.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/plugin.ts#L55"},"initialIsOpen":false}],"functions":[{"id":"def-public.fieldList","type":"Function","children":[{"type":"Array","label":"specs","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},"[]"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L35"}},{"type":"boolean","label":"shortDotsEnable","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L36"}}],"signature":["(specs?: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},"[], shortDotsEnable?: boolean) => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPatternFieldList","text":"IIndexPatternFieldList"}],"description":[],"label":"fieldList","source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L34"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.extractReferences","type":"Function","children":[{"type":"Object","label":"state","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"}],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/extract_references.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/extract_references.ts#L14"}}],"signature":["(state: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"},") => [",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"}," & { indexRefName?: string | undefined; }, ","SavedObjectReference","[]]"],"description":[],"label":"extractReferences","source":{"path":"src/plugins/data/common/search/search_source/extract_references.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/extract_references.ts#L13"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.getSearchParamsFromRequest","type":"Function","label":"getSearchParamsFromRequest","signature":["(searchRequest: Record, dependencies: { getConfig: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.GetConfigFn","text":"GetConfigFn"},"; }) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchRequestParams","text":"ISearchRequestParams"},">"],"description":[],"children":[{"type":"Object","label":"searchRequest","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/fetch/get_search_params.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L34"}},{"id":"def-public.getSearchParamsFromRequest.dependencies","type":"Object","label":"dependencies","description":[],"children":[{"id":"def-public.getSearchParamsFromRequest.dependencies.getConfig","type":"Function","label":"getConfig","description":[],"source":{"path":"src/plugins/data/common/search/search_source/fetch/get_search_params.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L35"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.GetConfigFn","text":"GetConfigFn"}]}],"source":{"path":"src/plugins/data/common/search/search_source/fetch/get_search_params.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L35"}}],"tags":["public"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/fetch/get_search_params.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L33"},"initialIsOpen":false},{"id":"def-public.injectReferences","type":"Function","children":[{"type":"CompoundType","label":"searchSourceFields","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"}," & { indexRefName: string; }"],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/inject_references.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/inject_references.ts#L13"}},{"type":"Array","label":"references","isRequired":true,"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[]"],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/inject_references.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/inject_references.ts#L14"}}],"signature":["(searchSourceFields: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"}," & { indexRefName: string; }, references: ","SavedObjectReference","[]) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"}],"description":[],"label":"injectReferences","source":{"path":"src/plugins/data/common/search/search_source/inject_references.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/inject_references.ts#L12"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.parseSearchSourceJSON","type":"Function","children":[{"type":"string","label":"searchSourceJSON","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/parse_json.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/parse_json.ts#L12"}}],"signature":["(searchSourceJSON: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"}],"description":[],"label":"parseSearchSourceJSON","source":{"path":"src/plugins/data/common/search/search_source/parse_json.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/parse_json.ts#L12"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.isErrorResponse","type":"Function","children":[{"type":"Object","label":"response","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IKibanaSearchResponse","text":"IKibanaSearchResponse"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/search/utils.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/utils.ts#L14"}}],"signature":["(response?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IKibanaSearchResponse","text":"IKibanaSearchResponse"}," | undefined) => boolean | undefined"],"description":[],"label":"isErrorResponse","source":{"path":"src/plugins/data/common/search/utils.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/utils.ts#L14"},"returnComment":["true if response had an error while executing in ES"],"initialIsOpen":false},{"id":"def-public.isCompleteResponse","type":"Function","children":[{"type":"Object","label":"response","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IKibanaSearchResponse","text":"IKibanaSearchResponse"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/search/utils.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/utils.ts#L21"}}],"signature":["(response?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IKibanaSearchResponse","text":"IKibanaSearchResponse"}," | undefined) => boolean"],"description":[],"label":"isCompleteResponse","source":{"path":"src/plugins/data/common/search/utils.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/utils.ts#L21"},"returnComment":["true if response is completed successfully"],"initialIsOpen":false},{"id":"def-public.isPartialResponse","type":"Function","children":[{"type":"Object","label":"response","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IKibanaSearchResponse","text":"IKibanaSearchResponse"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/search/utils.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/utils.ts#L28"}}],"signature":["(response?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IKibanaSearchResponse","text":"IKibanaSearchResponse"}," | undefined) => boolean"],"description":[],"label":"isPartialResponse","source":{"path":"src/plugins/data/common/search/utils.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/utils.ts#L28"},"returnComment":["true if request is still running an/d response contains partial results"],"initialIsOpen":false},{"id":"def-public.getTime","type":"Function","label":"getTime","signature":["(indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"}," | undefined, timeRange: ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"},", options: { forceNow?: Date | undefined; fieldName?: string | undefined; } | undefined) => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.RangeFilter","text":"RangeFilter"}," | undefined"],"description":[],"children":[{"type":"Object","label":"indexPattern","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/query/timefilter/get_time.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L38"}},{"type":"Object","label":"timeRange","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"}],"description":[],"source":{"path":"src/plugins/data/common/query/timefilter/get_time.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L39"}},{"id":"def-public.getTime.options","type":"Object","label":"options","description":[],"children":[{"id":"def-public.getTime.options.forceNow","type":"Object","label":"forceNow","description":[],"source":{"path":"src/plugins/data/common/query/timefilter/get_time.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L40"},"signature":["Date | undefined"]},{"id":"def-public.getTime.options.fieldName","type":"string","label":"fieldName","description":[],"source":{"path":"src/plugins/data/common/query/timefilter/get_time.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L40"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/data/common/query/timefilter/get_time.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L40"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/query/timefilter/get_time.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L37"},"initialIsOpen":false},{"id":"def-public.castEsToKbnFieldTypeName","type":"Function","children":[{"type":"string","label":"esType","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/kbn_field_types/kbn_field_types.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_types.ts#L39"}}],"signature":["(esType: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"}],"description":["\n Get the KbnFieldType name for an esType string\n"],"label":"castEsToKbnFieldTypeName","source":{"path":"src/plugins/data/common/kbn_field_types/kbn_field_types.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_types.ts#L39"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.getKbnTypeNames","type":"Function","children":[],"signature":["() => string[]"],"description":["\n Get the esTypes known by all kbnFieldTypes\n"],"label":"getKbnTypeNames","source":{"path":"src/plugins/data/common/kbn_field_types/kbn_field_types.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_types.ts#L30"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.isTimeRange","type":"Function","children":[{"type":"Unknown","label":"x","isRequired":true,"signature":["unknown"],"description":[],"source":{"path":"src/plugins/data/common/query/timefilter/is_time_range.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/is_time_range.ts#L11"}}],"signature":["(x: unknown) => x is ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"}],"description":[],"label":"isTimeRange","source":{"path":"src/plugins/data/common/query/timefilter/is_time_range.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/is_time_range.ts#L11"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.isQuery","type":"Function","children":[{"type":"Unknown","label":"x","isRequired":true,"signature":["unknown"],"description":[],"source":{"path":"src/plugins/data/common/query/is_query.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/is_query.ts#L11"}}],"signature":["(x: unknown) => x is ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.Query","text":"Query"}],"description":[],"label":"isQuery","source":{"path":"src/plugins/data/common/query/is_query.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/is_query.ts#L11"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.isFilter","type":"Function","children":[{"type":"Unknown","label":"x","isRequired":true,"signature":["unknown"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L103"}}],"signature":["(x: unknown) => x is ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}],"description":[],"label":"isFilter","source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L103"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.isFilters","type":"Function","children":[{"type":"Unknown","label":"x","isRequired":true,"signature":["unknown"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L110"}}],"signature":["(x: unknown) => x is ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]"],"description":[],"label":"isFilters","source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L110"},"returnComment":[],"initialIsOpen":false}],"interfaces":[{"id":"def-public.RangeFilterParams","type":"Interface","label":"RangeFilterParams","description":[],"children":[{"id":"def-public.RangeFilterParams.from","type":"CompoundType","label":"from","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L36"},"signature":["string | number | undefined"]},{"id":"def-public.RangeFilterParams.to","type":"CompoundType","label":"to","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L37"},"signature":["string | number | undefined"]},{"id":"def-public.RangeFilterParams.gt","type":"CompoundType","label":"gt","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L38"},"signature":["string | number | undefined"]},{"id":"def-public.RangeFilterParams.lt","type":"CompoundType","label":"lt","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L39"},"signature":["string | number | undefined"]},{"id":"def-public.RangeFilterParams.gte","type":"CompoundType","label":"gte","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L40"},"signature":["string | number | undefined"]},{"id":"def-public.RangeFilterParams.lte","type":"CompoundType","label":"lte","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L41"},"signature":["string | number | undefined"]},{"id":"def-public.RangeFilterParams.format","type":"string","label":"format","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L42"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L35"},"initialIsOpen":false},{"id":"def-public.EsQueryConfig","type":"Interface","label":"EsQueryConfig","description":[],"children":[{"id":"def-public.EsQueryConfig.allowLeadingWildcards","type":"boolean","label":"allowLeadingWildcards","description":[],"source":{"path":"src/plugins/data/common/es_query/es_query/build_es_query.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L18"}},{"id":"def-public.EsQueryConfig.queryStringOptions","type":"Object","label":"queryStringOptions","description":[],"source":{"path":"src/plugins/data/common/es_query/es_query/build_es_query.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L19"},"signature":["Record"]},{"id":"def-public.EsQueryConfig.ignoreFilterIfFieldNotInIndex","type":"boolean","label":"ignoreFilterIfFieldNotInIndex","description":[],"source":{"path":"src/plugins/data/common/es_query/es_query/build_es_query.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L20"}},{"id":"def-public.EsQueryConfig.dateFormatTZ","type":"string","label":"dateFormatTZ","description":[],"source":{"path":"src/plugins/data/common/es_query/es_query/build_es_query.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L21"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/data/common/es_query/es_query/build_es_query.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L17"},"initialIsOpen":false},{"id":"def-public.KueryNode","type":"Interface","label":"KueryNode","description":[],"children":[{"id":"def-public.KueryNode.type","type":"CompoundType","label":"type","description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/types.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L12"},"signature":["\"function\" | \"literal\" | \"namedArg\" | \"wildcard\""]},{"id":"def-public.KueryNode.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L13"},"signature":["any"]}],"source":{"path":"src/plugins/data/common/es_query/kuery/types.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L11"},"initialIsOpen":false},{"id":"def-public.FieldFormatConfig","type":"Interface","label":"FieldFormatConfig","description":[],"children":[{"id":"def-public.FieldFormatConfig.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/data/common/field_formats/types.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L62"}},{"id":"def-public.FieldFormatConfig.params","type":"Object","label":"params","description":[],"source":{"path":"src/plugins/data/common/field_formats/types.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L63"},"signature":["Record"]},{"id":"def-public.FieldFormatConfig.es","type":"CompoundType","label":"es","description":[],"source":{"path":"src/plugins/data/common/field_formats/types.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L64"},"signature":["boolean | undefined"]}],"source":{"path":"src/plugins/data/common/field_formats/types.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L61"},"initialIsOpen":false},{"id":"def-public.IIndexPatternFieldList","type":"Interface","label":"IIndexPatternFieldList","signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPatternFieldList","text":"IIndexPatternFieldList"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"},"[]"],"description":[],"children":[{"id":"def-public.IIndexPatternFieldList.add","type":"Function","label":"add","signature":["(field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},") => void"],"description":[],"children":[{"type":"Object","label":"field","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L18"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L18"}},{"id":"def-public.IIndexPatternFieldList.getAll","type":"Function","label":"getAll","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L19"}},{"id":"def-public.IIndexPatternFieldList.getByName","type":"Function","label":"getByName","signature":["(name: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"}," | undefined"],"description":[],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L20"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L20"}},{"id":"def-public.IIndexPatternFieldList.getByType","type":"Function","label":"getByType","signature":["(type: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"},"[]"],"description":[],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L21"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L21"}},{"id":"def-public.IIndexPatternFieldList.remove","type":"Function","label":"remove","signature":["(field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"},") => void"],"description":[],"children":[{"type":"Object","label":"field","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L22"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L22"}},{"id":"def-public.IIndexPatternFieldList.removeAll","type":"Function","label":"removeAll","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L23"}},{"id":"def-public.IIndexPatternFieldList.replaceAll","type":"Function","label":"replaceAll","signature":["(specs: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},"[]) => void"],"description":[],"children":[{"type":"Array","label":"specs","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},"[]"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L24"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L24"}},{"id":"def-public.IIndexPatternFieldList.update","type":"Function","label":"update","signature":["(field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},") => void"],"description":[],"children":[{"type":"Object","label":"field","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L25"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L25"}},{"id":"def-public.IIndexPatternFieldList.toSpec","type":"Function","label":"toSpec","signature":["(options?: { getFormatterForField?: ((field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"},") | undefined; } | undefined) => Record ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"},") | undefined"]}],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L26"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L26"}}],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L17"},"initialIsOpen":false},{"id":"def-public.IIndexPattern","type":"Interface","label":"IIndexPattern","description":["\nIIndexPattern allows for an IndexPattern OR an index pattern saved object\ntoo ambiguous, should be avoided"],"children":[{"id":"def-public.IIndexPattern.fields","type":"Array","label":"fields","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L32"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"},"[]"]},{"id":"def-public.IIndexPattern.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L33"}},{"id":"def-public.IIndexPattern.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L34"},"signature":["string | undefined"]},{"id":"def-public.IIndexPattern.type","type":"string","label":"type","description":["\nType is used for identifying rollup indices, otherwise left undefined"],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L38"},"signature":["string | undefined"]},{"id":"def-public.IIndexPattern.timeFieldName","type":"string","label":"timeFieldName","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L39"},"signature":["string | undefined"]},{"id":"def-public.IIndexPattern.getTimeField","type":"Function","label":"getTimeField","signature":["(() => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}," | undefined) | undefined"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L40"}},{"id":"def-public.IIndexPattern.fieldFormatMap","type":"Object","label":"fieldFormatMap","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L41"},"signature":["Record | undefined> | undefined"]},{"id":"def-public.IIndexPattern.getFormatterForField","type":"Function","label":"getFormatterForField","description":["\nLook up a formatter for a given field"],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L45"},"signature":["((field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"},") | undefined"]}],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L31"},"initialIsOpen":false},{"id":"def-public.IFieldType","type":"Interface","label":"IFieldType","description":[],"children":[{"id":"def-public.IFieldType.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L12"}},{"id":"def-public.IFieldType.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L13"}},{"id":"def-public.IFieldType.script","type":"string","label":"script","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L14"},"signature":["string | undefined"]},{"id":"def-public.IFieldType.lang","type":"string","label":"lang","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L15"},"signature":["string | undefined"]},{"id":"def-public.IFieldType.count","type":"number","label":"count","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L16"},"signature":["number | undefined"]},{"id":"def-public.IFieldType.esTypes","type":"Array","label":"esTypes","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L19"},"signature":["string[] | undefined"]},{"id":"def-public.IFieldType.aggregatable","type":"CompoundType","label":"aggregatable","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L20"},"signature":["boolean | undefined"]},{"id":"def-public.IFieldType.filterable","type":"CompoundType","label":"filterable","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L21"},"signature":["boolean | undefined"]},{"id":"def-public.IFieldType.searchable","type":"CompoundType","label":"searchable","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L22"},"signature":["boolean | undefined"]},{"id":"def-public.IFieldType.sortable","type":"CompoundType","label":"sortable","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L23"},"signature":["boolean | undefined"]},{"id":"def-public.IFieldType.visualizable","type":"CompoundType","label":"visualizable","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L24"},"signature":["boolean | undefined"]},{"id":"def-public.IFieldType.readFromDocValues","type":"CompoundType","label":"readFromDocValues","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L25"},"signature":["boolean | undefined"]},{"id":"def-public.IFieldType.scripted","type":"CompoundType","label":"scripted","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L26"},"signature":["boolean | undefined"]},{"id":"def-public.IFieldType.subType","type":"Object","label":"subType","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L27"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldSubType","text":"IFieldSubType"}," | undefined"]},{"id":"def-public.IFieldType.displayName","type":"string","label":"displayName","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L28"},"signature":["string | undefined"]},{"id":"def-public.IFieldType.customLabel","type":"string","label":"customLabel","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L29"},"signature":["string | undefined"]},{"id":"def-public.IFieldType.format","type":"Any","label":"format","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L30"},"signature":["any"]},{"id":"def-public.IFieldType.toSpec","type":"Function","label":"toSpec","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L31"},"signature":["((options?: { getFormatterForField?: ((field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"},") | undefined; } | undefined) => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"}]}],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L11"},"initialIsOpen":false},{"id":"def-public.IFieldSubType","type":"Interface","label":"IFieldSubType","description":[],"children":[{"id":"def-public.IFieldSubType.multi","type":"Object","label":"multi","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":154,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L154"},"signature":["{ parent: string; } | undefined"]},{"id":"def-public.IFieldSubType.nested","type":"Object","label":"nested","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":155,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L155"},"signature":["{ path: string; } | undefined"]}],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":153,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L153"},"initialIsOpen":false},{"id":"def-public.IndexPatternAttributes","type":"Interface","label":"IndexPatternAttributes","description":["\nInterface for an index pattern saved object"],"children":[{"id":"def-public.IndexPatternAttributes.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L54"}},{"id":"def-public.IndexPatternAttributes.fields","type":"string","label":"fields","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L55"}},{"id":"def-public.IndexPatternAttributes.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L56"}},{"id":"def-public.IndexPatternAttributes.typeMeta","type":"string","label":"typeMeta","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L57"}},{"id":"def-public.IndexPatternAttributes.timeFieldName","type":"string","label":"timeFieldName","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L58"},"signature":["string | undefined"]},{"id":"def-public.IndexPatternAttributes.intervalName","type":"string","label":"intervalName","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L59"},"signature":["string | undefined"]},{"id":"def-public.IndexPatternAttributes.sourceFilters","type":"string","label":"sourceFilters","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L60"},"signature":["string | undefined"]},{"id":"def-public.IndexPatternAttributes.fieldFormatMap","type":"string","label":"fieldFormatMap","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L61"},"signature":["string | undefined"]},{"id":"def-public.IndexPatternAttributes.fieldAttrs","type":"string","label":"fieldAttrs","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L62"},"signature":["string | undefined"]},{"id":"def-public.IndexPatternAttributes.runtimeFieldMap","type":"string","label":"runtimeFieldMap","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L63"},"signature":["string | undefined"]},{"id":"def-public.IndexPatternAttributes.allowNoIndex","type":"CompoundType","label":"allowNoIndex","description":["\nprevents errors when index pattern exists before indices"],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L67"},"signature":["boolean | undefined"]}],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L53"},"initialIsOpen":false},{"id":"def-public.TypeMeta","type":"Interface","label":"TypeMeta","description":[],"children":[{"id":"def-public.TypeMeta.aggs","type":"Object","label":"aggs","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":159,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L159"},"signature":["Record> | undefined"]},{"id":"def-public.TypeMeta.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":160,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L160"},"signature":["any"]}],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":158,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L158"},"initialIsOpen":false},{"id":"def-public.IndexPatternSpec","type":"Interface","label":"IndexPatternSpec","description":["\nStatic index pattern format\nSerialized data object, representing index pattern attributes and state"],"children":[{"id":"def-public.IndexPatternSpec.id","type":"string","label":"id","description":["\nsaved object id"],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":228,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L228"},"signature":["string | undefined"]},{"id":"def-public.IndexPatternSpec.version","type":"string","label":"version","description":["\nsaved object version string"],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":232,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L232"},"signature":["string | undefined"]},{"id":"def-public.IndexPatternSpec.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":233,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L233"},"signature":["string | undefined"]},{"id":"def-public.IndexPatternSpec.intervalName","type":"string","label":"intervalName","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":238,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L238"},"signature":["string | undefined"]},{"id":"def-public.IndexPatternSpec.timeFieldName","type":"string","label":"timeFieldName","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":239,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L239"},"signature":["string | undefined"]},{"id":"def-public.IndexPatternSpec.sourceFilters","type":"Array","label":"sourceFilters","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":240,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L240"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.SourceFilter","text":"SourceFilter"},"[] | undefined"]},{"id":"def-public.IndexPatternSpec.fields","type":"Object","label":"fields","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":241,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L241"},"signature":["Record | undefined"]},{"id":"def-public.IndexPatternSpec.typeMeta","type":"Object","label":"typeMeta","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":242,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L242"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.TypeMeta","text":"TypeMeta"}," | undefined"]},{"id":"def-public.IndexPatternSpec.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":243,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L243"},"signature":["string | undefined"]},{"id":"def-public.IndexPatternSpec.fieldFormats","type":"Object","label":"fieldFormats","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":244,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L244"},"signature":["Record>> | undefined"]},{"id":"def-public.IndexPatternSpec.runtimeFieldMap","type":"Object","label":"runtimeFieldMap","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":245,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L245"},"signature":["Record | undefined"]},{"id":"def-public.IndexPatternSpec.fieldAttrs","type":"Object","label":"fieldAttrs","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":246,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L246"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldAttrs","text":"FieldAttrs"}," | undefined"]},{"id":"def-public.IndexPatternSpec.allowNoIndex","type":"CompoundType","label":"allowNoIndex","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":247,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L247"},"signature":["boolean | undefined"]}],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":224,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L224"},"initialIsOpen":false},{"id":"def-public.AggFunctionsMapping","type":"Interface","label":"AggFunctionsMapping","description":["\nA global list of the expression function definitions for each agg type function."],"children":[{"id":"def-public.AggFunctionsMapping.aggFilter","type":"Object","label":"aggFilter","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":204,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L204"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggFilters","type":"Object","label":"aggFilters","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":205,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L205"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggSignificantTerms","type":"Object","label":"aggSignificantTerms","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":206,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L206"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggIpRange","type":"Object","label":"aggIpRange","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":207,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L207"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggDateRange","type":"Object","label":"aggDateRange","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":208,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L208"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggRange","type":"Object","label":"aggRange","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":209,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L209"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggGeoTile","type":"Object","label":"aggGeoTile","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":210,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L210"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggGeoHash","type":"Object","label":"aggGeoHash","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":211,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L211"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggHistogram","type":"Object","label":"aggHistogram","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":212,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L212"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggDateHistogram","type":"Object","label":"aggDateHistogram","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":213,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L213"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggTerms","type":"Object","label":"aggTerms","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":214,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L214"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggAvg","type":"Object","label":"aggAvg","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":215,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L215"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggBucketAvg","type":"Object","label":"aggBucketAvg","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":216,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L216"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggBucketMax","type":"Object","label":"aggBucketMax","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":217,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L217"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggBucketMin","type":"Object","label":"aggBucketMin","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":218,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L218"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggBucketSum","type":"Object","label":"aggBucketSum","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":219,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L219"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggCardinality","type":"Object","label":"aggCardinality","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":220,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L220"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggCount","type":"Object","label":"aggCount","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":221,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L221"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggCumulativeSum","type":"Object","label":"aggCumulativeSum","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":222,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L222"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggDerivative","type":"Object","label":"aggDerivative","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":223,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L223"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggGeoBounds","type":"Object","label":"aggGeoBounds","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":224,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L224"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggGeoCentroid","type":"Object","label":"aggGeoCentroid","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":225,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L225"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggMax","type":"Object","label":"aggMax","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":226,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L226"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggMedian","type":"Object","label":"aggMedian","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":227,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L227"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggMin","type":"Object","label":"aggMin","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":228,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L228"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggMovingAvg","type":"Object","label":"aggMovingAvg","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":229,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L229"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggPercentileRanks","type":"Object","label":"aggPercentileRanks","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":230,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L230"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggPercentiles","type":"Object","label":"aggPercentiles","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":231,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L231"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggSerialDiff","type":"Object","label":"aggSerialDiff","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":232,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L232"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggStdDeviation","type":"Object","label":"aggStdDeviation","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":233,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L233"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggSum","type":"Object","label":"aggSum","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":234,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L234"},"signature":["FunctionDefinition"]},{"id":"def-public.AggFunctionsMapping.aggTopHit","type":"Object","label":"aggTopHit","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":235,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L235"},"signature":["FunctionDefinition"]}],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":203,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L203"},"initialIsOpen":false},{"id":"def-public.AggParamOption","type":"Interface","label":"AggParamOption","description":[],"children":[{"id":"def-public.AggParamOption.val","type":"string","label":"val","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_params.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L31"}},{"id":"def-public.AggParamOption.display","type":"string","label":"display","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_params.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L32"}},{"id":"def-public.AggParamOption.enabled","type":"Function","label":"enabled","signature":["((agg: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},") => boolean) | undefined"],"description":[],"children":[{"type":"Object","label":"agg","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"}],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_params.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L33"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_params.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L33"}}],"source":{"path":"src/plugins/data/common/search/aggs/agg_params.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L30"},"initialIsOpen":false},{"id":"def-public.OptionedValueProp","type":"Interface","label":"OptionedValueProp","description":[],"children":[{"id":"def-public.OptionedValueProp.value","type":"string","label":"value","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/optioned.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L13"}},{"id":"def-public.OptionedValueProp.text","type":"string","label":"text","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/optioned.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L14"}},{"id":"def-public.OptionedValueProp.disabled","type":"CompoundType","label":"disabled","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/optioned.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L15"},"signature":["boolean | undefined"]},{"id":"def-public.OptionedValueProp.isCompatible","type":"Function","label":"isCompatible","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/optioned.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L16"},"signature":["(agg: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},") => boolean"]}],"source":{"path":"src/plugins/data/common/search/aggs/param_types/optioned.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L12"},"initialIsOpen":false},{"id":"def-public.IEsSearchRequest","type":"Interface","label":"IEsSearchRequest","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IEsSearchRequest","text":"IEsSearchRequest"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IKibanaSearchRequest","text":"IKibanaSearchRequest"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchRequestParams","text":"ISearchRequestParams"},">>"],"description":[],"children":[{"id":"def-public.IEsSearchRequest.indexType","type":"string","label":"indexType","description":[],"source":{"path":"src/plugins/data/common/search/es_search/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/es_search/types.ts#L20"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/data/common/search/es_search/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/es_search/types.ts#L19"},"initialIsOpen":false},{"id":"def-public.IKibanaSearchRequest","type":"Interface","label":"IKibanaSearchRequest","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IKibanaSearchRequest","text":"IKibanaSearchRequest"},""],"description":[],"children":[{"id":"def-public.IKibanaSearchRequest.id","type":"string","label":"id","description":["\nAn id can be used to uniquely identify this request."],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L78"},"signature":["string | undefined"]},{"id":"def-public.IKibanaSearchRequest.params","type":"Uncategorized","label":"params","description":[],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L80"},"signature":["Params | undefined"]}],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L74"},"initialIsOpen":false},{"id":"def-public.IKibanaSearchResponse","type":"Interface","label":"IKibanaSearchResponse","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IKibanaSearchResponse","text":"IKibanaSearchResponse"},""],"description":[],"children":[{"id":"def-public.IKibanaSearchResponse.id","type":"string","label":"id","description":["\nSome responses may contain a unique id to identify the request this response came from."],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L44"},"signature":["string | undefined"]},{"id":"def-public.IKibanaSearchResponse.total","type":"number","label":"total","description":["\nIf relevant to the search strategy, return a total number\nthat represents how progress is indicated."],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L50"},"signature":["number | undefined"]},{"id":"def-public.IKibanaSearchResponse.loaded","type":"number","label":"loaded","description":["\nIf relevant to the search strategy, return a loaded number\nthat represents how progress is indicated."],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L56"},"signature":["number | undefined"]},{"id":"def-public.IKibanaSearchResponse.isRunning","type":"CompoundType","label":"isRunning","description":["\nIndicates whether search is still in flight"],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L61"},"signature":["boolean | undefined"]},{"id":"def-public.IKibanaSearchResponse.isPartial","type":"CompoundType","label":"isPartial","description":["\nIndicates whether the results returned are complete or partial"],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L66"},"signature":["boolean | undefined"]},{"id":"def-public.IKibanaSearchResponse.rawResponse","type":"Uncategorized","label":"rawResponse","description":["\nThe raw response returned by the internal search method (usually the raw ES response)"],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L71"},"signature":["RawResponse"]}],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L40"},"initialIsOpen":false},{"id":"def-public.ISearchStartSearchSource","type":"Interface","label":"ISearchStartSearchSource","description":["\nhigh level search service"],"children":[{"id":"def-public.ISearchStartSearchSource.create","type":"Function","label":"create","description":["\ncreates {@link SearchSource} based on provided serialized {@link SearchSourceFields}"],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L30"},"signature":["(fields?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"}," | undefined) => Promise>"]},{"id":"def-public.ISearchStartSearchSource.createEmpty","type":"Function","label":"createEmpty","description":["\ncreates empty {@link SearchSource}"],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L34"},"signature":["() => Pick<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"},", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">"]}],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L25"},"initialIsOpen":false},{"id":"def-public.SearchSourceFields","type":"Interface","label":"SearchSourceFields","description":["\nsearch source fields"],"children":[{"id":"def-public.SearchSourceFields.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L62"},"signature":["string | undefined"]},{"id":"def-public.SearchSourceFields.query","type":"Object","label":"query","description":["\n{@link Query}"],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L66"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.Query","text":"Query"}," | undefined"]},{"id":"def-public.SearchSourceFields.filter","type":"CompoundType","label":"filter","description":["\n{@link Filter}"],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L70"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[] | (() => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[] | undefined) | undefined"]},{"id":"def-public.SearchSourceFields.sort","type":"CompoundType","label":"sort","description":["\n{@link EsQuerySortValue}"],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L74"},"signature":["Record | Record[] | undefined"]},{"id":"def-public.SearchSourceFields.highlight","type":"Any","label":"highlight","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L75"},"signature":["any"]},{"id":"def-public.SearchSourceFields.highlightAll","type":"CompoundType","label":"highlightAll","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":76,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L76"},"signature":["boolean | undefined"]},{"id":"def-public.SearchSourceFields.trackTotalHits","type":"CompoundType","label":"trackTotalHits","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L77"},"signature":["number | boolean | undefined"]},{"id":"def-public.SearchSourceFields.aggs","type":"Any","label":"aggs","description":["\n{@link AggConfigs}"],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L81"},"signature":["any"]},{"id":"def-public.SearchSourceFields.from","type":"number","label":"from","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L82"},"signature":["number | undefined"]},{"id":"def-public.SearchSourceFields.size","type":"number","label":"size","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L83"},"signature":["number | undefined"]},{"id":"def-public.SearchSourceFields.source","type":"CompoundType","label":"source","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L84"},"signature":["string | boolean | string[] | undefined"]},{"id":"def-public.SearchSourceFields.version","type":"CompoundType","label":"version","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":85,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L85"},"signature":["boolean | undefined"]},{"id":"def-public.SearchSourceFields.fields","type":"Array","label":"fields","description":["\nRetrieve fields via the search Fields API"],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L89"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchFieldValue","text":"SearchFieldValue"},"[] | undefined"]},{"id":"def-public.SearchSourceFields.fieldsFromSource","type":"CompoundType","label":"fieldsFromSource","description":["\nRetreive fields directly from _source (legacy behavior)\n"],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L95"},"signature":["string | boolean | string[] | undefined"]},{"id":"def-public.SearchSourceFields.index","type":"Object","label":"index","description":["\n{@link IndexPatternService}"],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L99"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}," | undefined"]},{"id":"def-public.SearchSourceFields.searchAfter","type":"Object","label":"searchAfter","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":100,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L100"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.EsQuerySearchAfter","text":"EsQuerySearchAfter"}," | undefined"]},{"id":"def-public.SearchSourceFields.timeout","type":"string","label":"timeout","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L101"},"signature":["string | undefined"]},{"id":"def-public.SearchSourceFields.terminate_after","type":"number","label":"terminate_after","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L102"},"signature":["number | undefined"]},{"id":"def-public.SearchSourceFields.parent","type":"Object","label":"parent","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L104"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"}," | undefined"]}],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L61"},"initialIsOpen":false},{"id":"def-public.SearchError","type":"Interface","label":"SearchError","description":[],"children":[{"id":"def-public.SearchError.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/data/common/search/search_source/fetch/types.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L37"}},{"id":"def-public.SearchError.status","type":"string","label":"status","description":[],"source":{"path":"src/plugins/data/common/search/search_source/fetch/types.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L38"}},{"id":"def-public.SearchError.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/search/search_source/fetch/types.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L39"}},{"id":"def-public.SearchError.message","type":"string","label":"message","description":[],"source":{"path":"src/plugins/data/common/search/search_source/fetch/types.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L40"}},{"id":"def-public.SearchError.path","type":"string","label":"path","description":[],"source":{"path":"src/plugins/data/common/search/search_source/fetch/types.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L41"}},{"id":"def-public.SearchError.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/common/search/search_source/fetch/types.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L42"}}],"source":{"path":"src/plugins/data/common/search/search_source/fetch/types.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L36"},"initialIsOpen":false},{"id":"def-public.ISearchOptions","type":"Interface","label":"ISearchOptions","description":[],"children":[{"id":"def-public.ISearchOptions.abortSignal","type":"Object","label":"abortSignal","description":["\nAn `AbortSignal` that allows the caller of `search` to abort a search request."],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":87,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L87"},"signature":["AbortSignal | undefined"]},{"id":"def-public.ISearchOptions.strategy","type":"string","label":"strategy","description":["\nUse this option to force using a specific server side search strategy. Leave empty to use the default strategy."],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L92"},"signature":["string | undefined"]},{"id":"def-public.ISearchOptions.legacyHitsTotal","type":"CompoundType","label":"legacyHitsTotal","description":["\nRequest the legacy format for the total number of hits. If sending `rest_total_hits_as_int` to\nsomething other than `true`, this should be set to `false`."],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L98"},"signature":["boolean | undefined"]},{"id":"def-public.ISearchOptions.sessionId","type":"string","label":"sessionId","description":["\nA session ID, grouping multiple search requests into a single session."],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L103"},"signature":["string | undefined"]},{"id":"def-public.ISearchOptions.isStored","type":"CompoundType","label":"isStored","description":["\nWhether the session is already saved (i.e. sent to background)"],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L108"},"signature":["boolean | undefined"]},{"id":"def-public.ISearchOptions.isRestore","type":"CompoundType","label":"isRestore","description":["\nWhether the session is restored (i.e. search requests should re-use the stored search IDs,\nrather than starting from scratch)"],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":114,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L114"},"signature":["boolean | undefined"]},{"id":"def-public.ISearchOptions.indexPattern","type":"Object","label":"indexPattern","description":["\nIndex pattern reference is used for better error messages"],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":120,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L120"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}," | undefined"]}],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L83"},"initialIsOpen":false},{"id":"def-public.RefreshInterval","type":"Interface","label":"RefreshInterval","description":[],"children":[{"id":"def-public.RefreshInterval.pause","type":"boolean","label":"pause","description":[],"source":{"path":"src/plugins/data/common/query/timefilter/types.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L12"}},{"id":"def-public.RefreshInterval.value","type":"number","label":"value","description":[],"source":{"path":"src/plugins/data/common/query/timefilter/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L13"}}],"source":{"path":"src/plugins/data/common/query/timefilter/types.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L11"},"initialIsOpen":false},{"id":"def-public.ApplyGlobalFilterActionContext","type":"Interface","label":"ApplyGlobalFilterActionContext","description":[],"children":[{"id":"def-public.ApplyGlobalFilterActionContext.filters","type":"Array","label":"filters","description":[],"source":{"path":"src/plugins/data/public/actions/apply_filter_action.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/actions/apply_filter_action.ts#L19"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]"]},{"id":"def-public.ApplyGlobalFilterActionContext.timeFieldName","type":"string","label":"timeFieldName","description":[],"source":{"path":"src/plugins/data/public/actions/apply_filter_action.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/actions/apply_filter_action.ts#L20"},"signature":["string | undefined"]},{"id":"def-public.ApplyGlobalFilterActionContext.embeddable","type":"Unknown","label":"embeddable","description":[],"source":{"path":"src/plugins/data/public/actions/apply_filter_action.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/actions/apply_filter_action.ts#L23"},"signature":["unknown"]}],"source":{"path":"src/plugins/data/public/actions/apply_filter_action.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/actions/apply_filter_action.ts#L18"},"initialIsOpen":false},{"id":"def-public.IDataPluginServices","type":"Interface","label":"IDataPluginServices","signature":[{"pluginId":"data","scope":"public","docId":"kibDataPluginApi","section":"def-public.IDataPluginServices","text":"IDataPluginServices"}," extends Partial<",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreStart","text":"CoreStart"},">"],"description":[],"children":[{"id":"def-public.IDataPluginServices.appName","type":"string","label":"appName","description":[],"source":{"path":"src/plugins/data/public/types.ts","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L116"}},{"id":"def-public.IDataPluginServices.uiSettings","type":"Object","label":"uiSettings","description":[],"source":{"path":"src/plugins/data/public/types.ts","lineNumber":117,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L117"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.IUiSettingsClient","text":"IUiSettingsClient"}]},{"id":"def-public.IDataPluginServices.savedObjects","type":"Object","label":"savedObjects","description":[],"source":{"path":"src/plugins/data/public/types.ts","lineNumber":118,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L118"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SavedObjectsStart","text":"SavedObjectsStart"}]},{"id":"def-public.IDataPluginServices.notifications","type":"Object","label":"notifications","description":[],"source":{"path":"src/plugins/data/public/types.ts","lineNumber":119,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L119"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.NotificationsStart","text":"NotificationsStart"}]},{"id":"def-public.IDataPluginServices.http","type":"Object","label":"http","description":[],"source":{"path":"src/plugins/data/public/types.ts","lineNumber":120,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L120"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpSetup","text":"HttpSetup"}]},{"id":"def-public.IDataPluginServices.storage","type":"Object","label":"storage","description":[],"source":{"path":"src/plugins/data/public/types.ts","lineNumber":121,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L121"},"signature":[{"pluginId":"kibanaUtils","scope":"public","docId":"kibKibanaUtilsPluginApi","section":"def-public.IStorageWrapper","text":"IStorageWrapper"},""]},{"id":"def-public.IDataPluginServices.data","type":"Object","label":"data","description":[],"source":{"path":"src/plugins/data/public/types.ts","lineNumber":122,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L122"},"signature":[{"pluginId":"data","scope":"public","docId":"kibDataPluginApi","section":"def-public.DataPublicPluginStart","text":"DataPublicPluginStart"}]},{"id":"def-public.IDataPluginServices.usageCollection","type":"Object","label":"usageCollection","description":[],"source":{"path":"src/plugins/data/public/types.ts","lineNumber":123,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L123"},"signature":[{"pluginId":"usageCollection","scope":"public","docId":"kibUsageCollectionPluginApi","section":"def-public.UsageCollectionStart","text":"UsageCollectionStart"}," | undefined"]}],"source":{"path":"src/plugins/data/public/types.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L115"},"initialIsOpen":false},{"id":"def-public.DataPublicPluginStartUi","type":"Interface","label":"DataPublicPluginStartUi","description":["\nData plugin prewired UI components"],"children":[{"id":"def-public.DataPublicPluginStartUi.IndexPatternSelect","type":"CompoundType","label":"IndexPatternSelect","description":[],"source":{"path":"src/plugins/data/public/types.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L60"},"signature":["React.ComponentType<",{"pluginId":"data","scope":"public","docId":"kibDataUiPluginApi","section":"def-public.IndexPatternSelectProps","text":"IndexPatternSelectProps"},">"]},{"id":"def-public.DataPublicPluginStartUi.SearchBar","type":"CompoundType","label":"SearchBar","description":[],"source":{"path":"src/plugins/data/public/types.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L61"},"signature":["React.ComponentType<",{"pluginId":"data","scope":"public","docId":"kibDataUiPluginApi","section":"def-public.StatefulSearchBarProps","text":"StatefulSearchBarProps"},">"]}],"source":{"path":"src/plugins/data/public/types.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L59"},"initialIsOpen":false},{"id":"def-public.DataPublicPluginStartActions","type":"Interface","label":"DataPublicPluginStartActions","description":["\nutilities to generate filters from action context"],"children":[{"id":"def-public.DataPublicPluginStartActions.createFiltersFromValueClickAction","type":"Function","label":"createFiltersFromValueClickAction","description":[],"source":{"path":"src/plugins/data/public/types.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L68"},"signature":["({ data, negate, }: ",{"pluginId":"data","scope":"public","docId":"kibDataPluginApi","section":"def-public.ValueClickDataContext","text":"ValueClickDataContext"},") => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]>"]},{"id":"def-public.DataPublicPluginStartActions.createFiltersFromRangeSelectAction","type":"Function","label":"createFiltersFromRangeSelectAction","description":[],"source":{"path":"src/plugins/data/public/types.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L69"},"signature":["typeof ",{"pluginId":"data","scope":"public","docId":"kibDataPluginApi","section":"def-public.createFiltersFromRangeSelectAction","text":"createFiltersFromRangeSelectAction"}]}],"source":{"path":"src/plugins/data/public/types.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L67"},"initialIsOpen":false}],"enums":[{"id":"def-public.ES_FIELD_TYPES","type":"Enum","label":"ES_FIELD_TYPES","description":[],"source":{"path":"src/plugins/data/common/kbn_field_types/types.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/types.ts#L18"},"initialIsOpen":false},{"id":"def-public.KBN_FIELD_TYPES","type":"Enum","label":"KBN_FIELD_TYPES","description":[],"source":{"path":"src/plugins/data/common/kbn_field_types/types.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/types.ts#L57"},"initialIsOpen":false},{"id":"def-public.BUCKET_TYPES","type":"Enum","label":"BUCKET_TYPES","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/bucket_agg_types.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/bucket_agg_types.ts#L9"},"initialIsOpen":false},{"id":"def-public.METRIC_TYPES","type":"Enum","label":"METRIC_TYPES","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/metric_agg_types.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_types.ts#L9"},"initialIsOpen":false},{"id":"def-public.SortDirection","type":"Enum","label":"SortDirection","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L39"},"initialIsOpen":false}],"misc":[{"id":"def-public.RangeFilter","type":"Type","label":"RangeFilter","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L60"},"signature":["Filter & EsRangeFilter & { meta: RangeFilterMeta; script?: { script: { params: any; lang: string; source: any;}; } | undefined; match_all?: any; }"],"initialIsOpen":false},{"id":"def-public.RangeFilterMeta","type":"Type","label":"RangeFilterMeta","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L50"},"signature":["FilterMeta & { params: RangeFilterParams; field?: any; formattedValue?: string | undefined; }"],"initialIsOpen":false},{"id":"def-public.ExistsFilter","type":"Type","label":"ExistsFilter","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/exists_filter.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/exists_filter.ts#L18"},"signature":["Filter & { meta: ExistsFilterMeta; exists?: FilterExistsProperty | undefined; }"],"initialIsOpen":false},{"id":"def-public.PhrasesFilter","type":"Type","label":"PhrasesFilter","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/phrases_filter.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrases_filter.ts#L19"},"signature":["Filter & { meta: PhrasesFilterMeta; }"],"initialIsOpen":false},{"id":"def-public.PhraseFilter","type":"Type","label":"PhraseFilter","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/phrase_filter.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L21"},"signature":["Filter & { meta: PhraseFilterMeta; script?: { script: { source?: any; lang?: string; params: any;}; } | undefined; }"],"initialIsOpen":false},{"id":"def-public.CustomFilter","type":"Type","label":"CustomFilter","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/custom_filter.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/custom_filter.ts#L11"},"signature":["Filter & { query: any; }"],"initialIsOpen":false},{"id":"def-public.MatchAllFilter","type":"Type","label":"MatchAllFilter","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/match_all_filter.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/match_all_filter.ts#L16"},"signature":["Filter & { meta: MatchAllFilterMeta; match_all: any; }"],"initialIsOpen":false},{"id":"def-public.IFieldFormat","type":"Type","label":"IFieldFormat","description":[],"source":{"path":"src/plugins/data/common/field_formats/types.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L69"},"signature":["FieldFormat"],"initialIsOpen":false},{"id":"def-public.FieldFormatInstanceType","type":"Type","label":"FieldFormatInstanceType","description":[],"source":{"path":"src/plugins/data/common/field_formats/types.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L77"},"signature":["(new (params?: any, getConfig?: GetConfigFn | undefined) => FieldFormat) & { id: FieldFormatId; title: string; fieldType: string | string[]; }"],"initialIsOpen":false},{"id":"def-public.IFieldFormatsRegistry","type":"Type","label":"IFieldFormatsRegistry","description":[],"source":{"path":"src/plugins/data/common/field_formats/index.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/index.ts#L11"},"signature":["{ init: (getConfig: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.GetConfigFn","text":"GetConfigFn"},", metaParamsOptions?: Record, defaultFieldConverters?: ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatInstanceType","text":"FieldFormatInstanceType"},"[]) => void; register: (fieldFormats: ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatInstanceType","text":"FieldFormatInstanceType"},"[]) => void; deserialize: ","FormatFactory","; getDefaultConfig: (fieldType: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"}],"initialIsOpen":false},{"id":"def-public.FieldFormatsContentType","type":"Type","label":"FieldFormatsContentType","description":[],"source":{"path":"src/plugins/data/common/field_formats/types.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L14"},"signature":["\"html\" | \"text\""],"initialIsOpen":false},{"id":"def-public.FieldFormatsGetConfigFn","type":"Type","label":"FieldFormatsGetConfigFn","description":[],"source":{"path":"src/plugins/data/common/field_formats/types.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L67"},"signature":["(key: string, defaultOverride: T | undefined) => T"],"initialIsOpen":false},{"id":"def-public.FieldFormatId","type":"Type","label":"FieldFormatId","description":[],"source":{"path":"src/plugins/data/common/field_formats/types.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L74"},"signature":["string"],"initialIsOpen":false},{"id":"def-public.IndexPatternsContract","type":"Type","label":"IndexPatternsContract","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":638,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L638"},"signature":["{ get: (id: string) => Promise; delete: (indexPatternId: string) => Promise<{}>; create: (spec: IndexPatternSpec, skipFetchFields?: boolean) => Promise; ensureDefaultIndexPattern: EnsureDefaultIndexPattern; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; find: (search: string, size?: number) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<{ id: string; title: string; }[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise[] | null | undefined>; getDefault: () => Promise; setDefault: (id: string, force?: boolean) => Promise; getFieldsForWildcard: (options: GetFieldsOptions) => Promise; getFieldsForIndexPattern: (indexPattern: IndexPattern | IndexPatternSpec, options?: GetFieldsOptions | undefined) => Promise; refreshFields: (indexPattern: IndexPattern) => Promise; fieldArrayToMap: (fields: FieldSpec[], fieldAttrs?: FieldAttrs | undefined) => Record; savedObjectToSpec: (savedObject: SavedObject) => IndexPatternSpec; createAndSave: (spec: IndexPatternSpec, override?: boolean, skipFetchFields?: boolean) => Promise; createSavedObject: (indexPattern: IndexPattern, override?: boolean) => Promise; updateSavedObject: (indexPattern: IndexPattern, saveAttempts?: number, ignoreErrors?: boolean) => Promise; }"],"initialIsOpen":false},{"id":"def-public.AggregationRestrictions","type":"Type","label":"AggregationRestrictions","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":141,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L141"},"signature":["{ [x: string]: { agg?: string | undefined; interval?: number | undefined; fixed_interval?: string | undefined; calendar_interval?: string | undefined; delay?: string | undefined; time_zone?: string | undefined; }; }"],"initialIsOpen":false},{"id":"def-public.IndexPatternLoadExpressionFunctionDefinition","type":"Type","label":"IndexPatternLoadExpressionFunctionDefinition","description":[],"source":{"path":"src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/expressions/load_index_pattern.ts#L34"},"signature":["ExpressionFunctionDefinition<\"indexPatternLoad\", null, Arguments, Output, ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},"<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},">>"],"initialIsOpen":false},{"id":"def-public.AggConfigSerialized","type":"Type","label":"AggConfigSerialized","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L32"},"signature":["{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | SerializableState | undefined; schema?: string | undefined; }"],"initialIsOpen":false},{"id":"def-public.AggGroupName","type":"Type","label":"AggGroupName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_groups.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L18"},"signature":["\"buckets\" | \"metrics\" | \"none\""],"initialIsOpen":false},{"id":"def-public.AggParam","type":"Type","label":"AggParam","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_params.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L28"},"signature":["BaseParamType"],"initialIsOpen":false},{"id":"def-public.AggConfigOptions","type":"Type","label":"AggConfigOptions","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L43"},"signature":["{ type: IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | SerializableState | undefined; }"],"initialIsOpen":false},{"id":"def-public.EsaggsExpressionFunctionDefinition","type":"Type","label":"EsaggsExpressionFunctionDefinition","description":[],"source":{"path":"src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#L35"},"signature":["ExpressionFunctionDefinition<\"esaggs\", Input, Arguments, Output, ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},"<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},">>"],"initialIsOpen":false},{"id":"def-public.IAggConfig","type":"Type","label":"IAggConfig","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L53"},"signature":["AggConfig"],"initialIsOpen":false},{"id":"def-public.IAggConfigs","type":"Type","label":"IAggConfigs","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L55"},"signature":["AggConfigs"],"initialIsOpen":false},{"id":"def-public.IAggType","type":"Type","label":"IAggType","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L58"},"signature":["AggType>"],"initialIsOpen":false},{"id":"def-public.IFieldParamType","type":"Type","label":"IFieldParamType","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/field.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/field.ts#L21"},"signature":["FieldParamType"],"initialIsOpen":false},{"id":"def-public.IMetricAggType","type":"Type","label":"IMetricAggType","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L35"},"signature":["MetricAggType"],"initialIsOpen":false},{"id":"def-public.ParsedInterval","type":"Type","label":"ParsedInterval","description":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts#L18"},"signature":["{ value: number; unit: Unit; type: \"calendar\" | \"fixed\"; }"],"initialIsOpen":false},{"id":"def-public.ExecutionContextSearch","type":"Type","label":"ExecutionContextSearch","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context_type.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L14"},"signature":["{ filters?: Filter[] | undefined; query?: Query | Query[] | undefined; timeRange?: TimeRange | undefined; }"],"initialIsOpen":false},{"id":"def-public.ExpressionFunctionKibana","type":"Type","label":"ExpressionFunctionKibana","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana.ts#L17"},"signature":["ExpressionFunctionDefinition<\"kibana\", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"kibana_context\", ExecutionContextSearch> | null, object, ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"kibana_context\", ExecutionContextSearch>, ExecutionContext>"],"initialIsOpen":false},{"id":"def-public.ExpressionFunctionKibanaContext","type":"Type","label":"ExpressionFunctionKibanaContext","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L23"},"signature":["ExpressionFunctionDefinition<\"kibana_context\", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"kibana_context\", ExecutionContextSearch> | null, Arguments, Promise<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"kibana_context\", ExecutionContextSearch>>, ExecutionContext>"],"initialIsOpen":false},{"id":"def-public.ExpressionValueSearchContext","type":"Type","label":"ExpressionValueSearchContext","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context_type.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L20"},"signature":["{ type: \"kibana_context\"; } & ExecutionContextSearch"],"initialIsOpen":false},{"id":"def-public.KibanaContext","type":"Type","label":"KibanaContext","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context_type.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L27"},"signature":["{ type: \"kibana_context\"; } & ExecutionContextSearch"],"initialIsOpen":false},{"id":"def-public.ES_SEARCH_STRATEGY","type":"string","label":"ES_SEARCH_STRATEGY","description":[],"source":{"path":"src/plugins/data/common/search/es_search/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/es_search/types.ts#L13"},"signature":["\"es\""],"initialIsOpen":false},{"id":"def-public.EsQuerySortValue","type":"Type","label":"EsQuerySortValue","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L49"},"signature":["{ [x: string]: SortDirection | SortDirectionNumeric; }"],"initialIsOpen":false},{"id":"def-public.IEsSearchResponse","type":"Type","label":"IEsSearchResponse","description":[],"source":{"path":"src/plugins/data/common/search/es_search/types.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/es_search/types.ts#L23"},"signature":["IKibanaSearchResponse>"],"initialIsOpen":false},{"id":"def-public.ISearchGeneric","type":"Type","label":"ISearchGeneric","description":[],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L13"},"signature":["(request: SearchStrategyRequest, options: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"}," | undefined) => ","Observable",""],"initialIsOpen":false},{"id":"def-public.ISearchSource","type":"Type","label":"ISearchSource","description":["\nsearch source interface"],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L19"},"signature":["{ create: () => SearchSource; history: Record[]; setPreferredSearchStrategyId: (searchStrategyId: string) => void; setField: (field: K, value: SearchSourceFields[K]) => SearchSource; removeField: (field: K) => SearchSource; setFields: (newFields: SearchSourceFields) => SearchSource; getId: () => string; getFields: () => SearchSourceFields; getField: (field: K, recurse?: boolean) => SearchSourceFields[K]; getOwnField: (field: K) => SearchSourceFields[K]; createCopy: () => SearchSource; createChild: (options?: {}) => SearchSource; setParent: (parent?: Pick | undefined, options?: SearchSourceOptions) => SearchSource; getParent: () => SearchSource | undefined; fetch$: (options?: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"},") => ","Observable","<","SearchResponse",">; fetch: (options?: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"},") => Promise<","SearchResponse"],"initialIsOpen":false},{"id":"def-public.SearchRequest","type":"Type","label":"SearchRequest","description":[],"source":{"path":"src/plugins/data/common/search/search_source/fetch/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L20"},"signature":["{ [x: string]: any; }"],"initialIsOpen":false},{"id":"def-public.Filter","type":"Type","label":"Filter","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L41"},"signature":["{ $state?: FilterState | undefined; meta: FilterMeta; query?: any; }"],"initialIsOpen":false},{"id":"def-public.Query","type":"Type","label":"Query","description":[],"source":{"path":"src/plugins/data/common/query/types.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/types.ts#L12"},"signature":["{ query: string | { [key: string]: any; }; language: string; }"],"initialIsOpen":false},{"id":"def-public.TimeRange","type":"Type","label":"TimeRange","description":[],"source":{"path":"src/plugins/data/common/query/timefilter/types.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L17"},"signature":["{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }"],"initialIsOpen":false},{"id":"def-public.AggsStart","type":"Type","label":"AggsStart","description":["\nAggsStart represents the actual external contract as AggsCommonStart\nis only used internally. The difference is that AggsStart includes the\ntypings for the registry with initialized agg types.\n"],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":139,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L139"},"signature":["{ calculateAutoTimeExpression: (range: TimeRange) => string | undefined; getDateMetaByDatatableColumn: (column: DatatableColumn) => Promise<{ timeZone: string; timeRange?: TimeRange | undefined; interval: string; } | undefined>; datatableUtilities: { getIndexPattern: (column: DatatableColumn) => Promise; getAggConfig: (column: DatatableColumn) => Promise; isFilterable: (column: DatatableColumn) => boolean; }; createAggConfigs: (indexPattern: IndexPattern, configStates?: Pick & Pick<{ type: string | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IAggType","text":"IAggType"},"; }, \"type\"> & Pick<{ type: string | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IAggType","text":"IAggType"},"; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[] | undefined) => AggConfigs; types: AggTypesRegistryStart; }"],"initialIsOpen":false},{"id":"def-public.ACTION_GLOBAL_APPLY_FILTER","type":"string","label":"ACTION_GLOBAL_APPLY_FILTER","description":[],"source":{"path":"src/plugins/data/public/actions/apply_filter_action.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/actions/apply_filter_action.ts#L16"},"signature":["\"ACTION_GLOBAL_APPLY_FILTER\""],"initialIsOpen":false},{"id":"def-public.APPLY_FILTER_TRIGGER","type":"string","label":"APPLY_FILTER_TRIGGER","description":[],"source":{"path":"src/plugins/data/public/triggers/apply_filter_trigger.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/triggers/apply_filter_trigger.ts#L12"},"signature":["\"FILTER_TRIGGER\""],"initialIsOpen":false}],"objects":[{"id":"def-public.esFilters","type":"Object","children":[{"id":"def-public.esFilters.FilterLabel","type":"Function","label":"FilterLabel","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L56"},"signature":["(props: ",{"pluginId":"data","scope":"public","docId":"kibDataUiPluginApi","section":"def-public.FilterLabelProps","text":"FilterLabelProps"},") => JSX.Element"]},{"id":"def-public.esFilters.FILTERS","type":"Object","label":"FILTERS","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L58"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.FILTERS","text":"FILTERS"}]},{"id":"def-public.esFilters.FilterStateStore","type":"Object","label":"FilterStateStore","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L59"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.FilterStateStore","text":"FilterStateStore"}]},{"id":"def-public.esFilters.buildEmptyFilter","type":"Function","label":"buildEmptyFilter","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L61"},"signature":["(isPinned: boolean, index?: string | undefined) => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}]},{"id":"def-public.esFilters.buildPhrasesFilter","type":"Function","label":"buildPhrasesFilter","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L62"},"signature":["(field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"},", params: any[], indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.PhrasesFilter","text":"PhrasesFilter"}]},{"id":"def-public.esFilters.buildExistsFilter","type":"Function","label":"buildExistsFilter","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L63"},"signature":["(field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"},", indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ExistsFilter","text":"ExistsFilter"}]},{"id":"def-public.esFilters.buildPhraseFilter","type":"Function","label":"buildPhraseFilter","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L64"},"signature":["(field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"},", value: any, indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.PhraseFilter","text":"PhraseFilter"}]},{"id":"def-public.esFilters.buildQueryFilter","type":"Function","label":"buildQueryFilter","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L65"},"signature":["(query: any, index: string, alias: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.QueryStringFilter","text":"QueryStringFilter"}]},{"id":"def-public.esFilters.buildRangeFilter","type":"Function","label":"buildRangeFilter","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L66"},"signature":["(field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"},", params: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.RangeFilterParams","text":"RangeFilterParams"},", indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"},", formattedValue?: string | undefined) => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.RangeFilter","text":"RangeFilter"}]},{"id":"def-public.esFilters.isPhraseFilter","type":"Function","label":"isPhraseFilter","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L68"},"signature":["(filter: any) => filter is ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.PhraseFilter","text":"PhraseFilter"}]},{"id":"def-public.esFilters.isExistsFilter","type":"Function","label":"isExistsFilter","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L69"},"signature":["(filter: any) => filter is ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ExistsFilter","text":"ExistsFilter"}]},{"id":"def-public.esFilters.isPhrasesFilter","type":"Function","label":"isPhrasesFilter","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L70"},"signature":["(filter: any) => filter is ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.PhrasesFilter","text":"PhrasesFilter"}]},{"id":"def-public.esFilters.isRangeFilter","type":"Function","label":"isRangeFilter","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L71"},"signature":["(filter: any) => filter is ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.RangeFilter","text":"RangeFilter"}]},{"id":"def-public.esFilters.isMatchAllFilter","type":"Function","label":"isMatchAllFilter","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L72"},"signature":["(filter: any) => filter is ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.MatchAllFilter","text":"MatchAllFilter"}]},{"id":"def-public.esFilters.isMissingFilter","type":"Function","label":"isMissingFilter","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L73"},"signature":["(filter: any) => filter is ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.MissingFilter","text":"MissingFilter"}]},{"id":"def-public.esFilters.isQueryStringFilter","type":"Function","label":"isQueryStringFilter","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L74"},"signature":["(filter: any) => filter is ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.QueryStringFilter","text":"QueryStringFilter"}]},{"id":"def-public.esFilters.isFilterPinned","type":"Function","label":"isFilterPinned","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L75"},"signature":["(filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},") => boolean | undefined"]},{"id":"def-public.esFilters.toggleFilterNegated","type":"Function","label":"toggleFilterNegated","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L77"},"signature":["(filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},") => { meta: { negate: boolean; alias: string | null; disabled: boolean; controlledBy?: string | undefined; index?: string | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; $state?: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.FilterState","text":"FilterState"}," | undefined; query?: any; }"]},{"id":"def-public.esFilters.disableFilter","type":"Function","label":"disableFilter","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L78"},"signature":["(filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}]},{"id":"def-public.esFilters.getPhraseFilterField","type":"Function","label":"getPhraseFilterField","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L79"},"signature":["(filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.PhraseFilter","text":"PhraseFilter"},") => string"]},{"id":"def-public.esFilters.getPhraseFilterValue","type":"Function","label":"getPhraseFilterValue","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L80"},"signature":["(filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.PhraseFilter","text":"PhraseFilter"},") => PhraseFilterValue"]},{"id":"def-public.esFilters.getDisplayValueFromFilter","type":"Function","label":"getDisplayValueFromFilter","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L81"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.getDisplayValueFromFilter","text":"getDisplayValueFromFilter"}]},{"id":"def-public.esFilters.compareFilters","type":"Function","label":"compareFilters","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L83"},"signature":["(first: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[], second: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[], comparatorOptions?: ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.FilterCompareOptions","text":"FilterCompareOptions"}]},{"id":"def-public.esFilters.COMPARE_ALL_OPTIONS","type":"Object","label":"COMPARE_ALL_OPTIONS","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L84"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.FilterCompareOptions","text":"FilterCompareOptions"}]},{"id":"def-public.esFilters.generateFilters","type":"Function","label":"generateFilters","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":85,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L85"},"signature":["typeof ",{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.generateFilters","text":"generateFilters"}]},{"id":"def-public.esFilters.onlyDisabledFiltersChanged","type":"Function","label":"onlyDisabledFiltersChanged","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L86"},"signature":["(newFilters?: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[] | undefined, oldFilters?: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[] | undefined) => boolean"]},{"id":"def-public.esFilters.changeTimeFilter","type":"Function","label":"changeTimeFilter","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L88"},"signature":["typeof ",{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.changeTimeFilter","text":"changeTimeFilter"}]},{"id":"def-public.esFilters.convertRangeFilterToTimeRangeString","type":"Function","label":"convertRangeFilterToTimeRangeString","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L89"},"signature":["typeof ",{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.convertRangeFilterToTimeRangeString","text":"convertRangeFilterToTimeRangeString"}]},{"id":"def-public.esFilters.mapAndFlattenFilters","type":"Function","label":"mapAndFlattenFilters","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L90"},"signature":["(filters: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]) => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]"]},{"id":"def-public.esFilters.extractTimeFilter","type":"Function","label":"extractTimeFilter","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":91,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L91"},"signature":["typeof ",{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.extractTimeFilter","text":"extractTimeFilter"}]},{"id":"def-public.esFilters.extractTimeRange","type":"Function","label":"extractTimeRange","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L92"},"signature":["typeof ",{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.extractTimeRange","text":"extractTimeRange"}]}],"description":[],"label":"esFilters","source":{"path":"src/plugins/data/public/index.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L55"},"initialIsOpen":false},{"id":"def-public.esKuery","type":"Object","children":[{"id":"def-public.esKuery.nodeTypes","type":"Object","label":"nodeTypes","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":122,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L122"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.NodeTypes","text":"NodeTypes"}]},{"id":"def-public.esKuery.fromKueryExpression","type":"Function","label":"fromKueryExpression","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":123,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L123"},"signature":["(expression: any, parseOptions?: Partial<",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KueryParseOptions","text":"KueryParseOptions"},">) => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KueryNode","text":"KueryNode"}]},{"id":"def-public.esKuery.toElasticsearchQuery","type":"Function","label":"toElasticsearchQuery","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":124,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L124"},"signature":["(node: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KueryNode","text":"KueryNode"},", indexPattern?: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"}," | undefined, config?: Record | undefined, context?: Record | undefined) => ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.JsonObject","text":"JsonObject"}]}],"description":[],"label":"esKuery","source":{"path":"src/plugins/data/public/index.ts","lineNumber":121,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L121"},"initialIsOpen":false},{"id":"def-public.esQuery","type":"Object","children":[{"id":"def-public.esQuery.buildEsQuery","type":"Function","label":"buildEsQuery","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":128,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L128"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.buildEsQuery","text":"buildEsQuery"}]},{"id":"def-public.esQuery.getEsQueryConfig","type":"Function","label":"getEsQueryConfig","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":129,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L129"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.getEsQueryConfig","text":"getEsQueryConfig"}]},{"id":"def-public.esQuery.buildQueryFromFilters","type":"Function","label":"buildQueryFromFilters","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":130,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L130"},"signature":["(filters: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[] | undefined, indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"}," | undefined, ignoreFilterIfFieldNotInIndex?: boolean) => { must: never[]; filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]; should: never[]; must_not: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]; }"]},{"id":"def-public.esQuery.luceneStringToDsl","type":"Function","label":"luceneStringToDsl","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L131"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.luceneStringToDsl","text":"luceneStringToDsl"}]},{"id":"def-public.esQuery.decorateQuery","type":"Function","label":"decorateQuery","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":132,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L132"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.decorateQuery","text":"decorateQuery"}]}],"description":[],"label":"esQuery","source":{"path":"src/plugins/data/public/index.ts","lineNumber":127,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L127"},"initialIsOpen":false},{"id":"def-public.fieldFormats","type":"Object","children":[{"id":"def-public.fieldFormats.FieldFormat","type":"Object","label":"FieldFormat","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":168,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L168"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"}]},{"id":"def-public.fieldFormats.FieldFormatsRegistry","type":"Object","label":"FieldFormatsRegistry","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":169,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L169"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatsRegistry","text":"FieldFormatsRegistry"}]},{"id":"def-public.fieldFormats.DEFAULT_CONVERTER_COLOR","type":"Object","label":"DEFAULT_CONVERTER_COLOR","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":171,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L171"},"signature":["{ range: string; regex: string; text: string; background: string; }"]},{"id":"def-public.fieldFormats.HTML_CONTEXT_TYPE","type":"CompoundType","label":"HTML_CONTEXT_TYPE","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":172,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L172"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatsContentType","text":"FieldFormatsContentType"}]},{"id":"def-public.fieldFormats.TEXT_CONTEXT_TYPE","type":"CompoundType","label":"TEXT_CONTEXT_TYPE","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":173,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L173"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatsContentType","text":"FieldFormatsContentType"}]},{"id":"def-public.fieldFormats.FIELD_FORMAT_IDS","type":"Object","label":"FIELD_FORMAT_IDS","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":174,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L174"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FIELD_FORMAT_IDS","text":"FIELD_FORMAT_IDS"}]},{"id":"def-public.fieldFormats.BoolFormat","type":"Object","label":"BoolFormat","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":176,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L176"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.BoolFormat","text":"BoolFormat"}]},{"id":"def-public.fieldFormats.BytesFormat","type":"Object","label":"BytesFormat","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":177,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L177"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.BytesFormat","text":"BytesFormat"}]},{"id":"def-public.fieldFormats.ColorFormat","type":"Object","label":"ColorFormat","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":178,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L178"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.ColorFormat","text":"ColorFormat"}]},{"id":"def-public.fieldFormats.DateFormat","type":"Object","label":"DateFormat","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":179,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L179"},"signature":["typeof ",{"pluginId":"data","scope":"public","docId":"kibDataFieldFormatsPluginApi","section":"def-public.DateFormat","text":"DateFormat"}]},{"id":"def-public.fieldFormats.DateNanosFormat","type":"Object","label":"DateNanosFormat","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":180,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L180"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.DateNanosFormat","text":"DateNanosFormat"}]},{"id":"def-public.fieldFormats.DurationFormat","type":"Object","label":"DurationFormat","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":181,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L181"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.DurationFormat","text":"DurationFormat"}]},{"id":"def-public.fieldFormats.IpFormat","type":"Object","label":"IpFormat","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":182,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L182"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.IpFormat","text":"IpFormat"}]},{"id":"def-public.fieldFormats.NumberFormat","type":"Object","label":"NumberFormat","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":183,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L183"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.NumberFormat","text":"NumberFormat"}]},{"id":"def-public.fieldFormats.PercentFormat","type":"Object","label":"PercentFormat","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":184,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L184"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.PercentFormat","text":"PercentFormat"}]},{"id":"def-public.fieldFormats.RelativeDateFormat","type":"Object","label":"RelativeDateFormat","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":185,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L185"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.RelativeDateFormat","text":"RelativeDateFormat"}]},{"id":"def-public.fieldFormats.SourceFormat","type":"Object","label":"SourceFormat","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":186,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L186"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.SourceFormat","text":"SourceFormat"}]},{"id":"def-public.fieldFormats.StaticLookupFormat","type":"Object","label":"StaticLookupFormat","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":187,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L187"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.StaticLookupFormat","text":"StaticLookupFormat"}]},{"id":"def-public.fieldFormats.UrlFormat","type":"Object","label":"UrlFormat","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":188,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L188"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.UrlFormat","text":"UrlFormat"}]},{"id":"def-public.fieldFormats.StringFormat","type":"Object","label":"StringFormat","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":189,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L189"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.StringFormat","text":"StringFormat"}]},{"id":"def-public.fieldFormats.TruncateFormat","type":"Object","label":"TruncateFormat","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":190,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L190"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.TruncateFormat","text":"TruncateFormat"}]}],"description":[],"label":"fieldFormats","source":{"path":"src/plugins/data/public/index.ts","lineNumber":167,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L167"},"initialIsOpen":false},{"id":"def-public.exporters","type":"Object","children":[{"id":"def-public.exporters.datatableToCSV","type":"Function","label":"datatableToCSV","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":210,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L210"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.datatableToCSV","text":"datatableToCSV"}]},{"id":"def-public.exporters.CSV_MIME_TYPE","type":"string","label":"CSV_MIME_TYPE","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":211,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L211"}}],"description":[],"label":"exporters","source":{"path":"src/plugins/data/public/index.ts","lineNumber":209,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L209"},"initialIsOpen":false},{"id":"def-public.indexPatterns","type":"Object","children":[{"id":"def-public.indexPatterns.ILLEGAL_CHARACTERS_KEY","type":"string","label":"ILLEGAL_CHARACTERS_KEY","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":235,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L235"}},{"id":"def-public.indexPatterns.CONTAINS_SPACES_KEY","type":"string","label":"CONTAINS_SPACES_KEY","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":236,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L236"}},{"id":"def-public.indexPatterns.ILLEGAL_CHARACTERS_VISIBLE","type":"Array","label":"ILLEGAL_CHARACTERS_VISIBLE","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":237,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L237"},"signature":["string[]"]},{"id":"def-public.indexPatterns.ILLEGAL_CHARACTERS","type":"Array","label":"ILLEGAL_CHARACTERS","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":238,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L238"},"signature":["string[]"]},{"id":"def-public.indexPatterns.isDefault","type":"Function","label":"isDefault","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":239,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L239"},"signature":["(indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"},") => boolean"]},{"id":"def-public.indexPatterns.isFilterable","type":"Function","label":"isFilterable","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":240,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L240"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.isFilterable","text":"isFilterable"}]},{"id":"def-public.indexPatterns.isNestedField","type":"Function","label":"isNestedField","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":241,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L241"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.isNestedField","text":"isNestedField"}]},{"id":"def-public.indexPatterns.validate","type":"Function","label":"validate","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":242,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L242"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.validateIndexPattern","text":"validateIndexPattern"}]},{"id":"def-public.indexPatterns.flattenHitWrapper","type":"Function","label":"flattenHitWrapper","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":243,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L243"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.flattenHitWrapper","text":"flattenHitWrapper"}]},{"id":"def-public.indexPatterns.formatHitProvider","type":"Function","label":"formatHitProvider","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":244,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L244"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.formatHitProvider","text":"formatHitProvider"}]}],"description":[],"label":"indexPatterns","source":{"path":"src/plugins/data/public/index.ts","lineNumber":234,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L234"},"initialIsOpen":false},{"id":"def-public.UI_SETTINGS","type":"Object","label":"UI_SETTINGS","description":[],"source":{"path":"src/plugins/data/common/constants.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/constants.ts#L11"},"signature":["{ readonly META_FIELDS: \"metaFields\"; readonly DOC_HIGHLIGHT: \"doc_table:highlight\"; readonly QUERY_STRING_OPTIONS: \"query:queryString:options\"; readonly QUERY_ALLOW_LEADING_WILDCARDS: \"query:allowLeadingWildcards\"; readonly SEARCH_QUERY_LANGUAGE: \"search:queryLanguage\"; readonly SORT_OPTIONS: \"sort:options\"; readonly COURIER_IGNORE_FILTER_IF_FIELD_NOT_IN_INDEX: \"courier:ignoreFilterIfFieldNotInIndex\"; readonly COURIER_SET_REQUEST_PREFERENCE: \"courier:setRequestPreference\"; readonly COURIER_CUSTOM_REQUEST_PREFERENCE: \"courier:customRequestPreference\"; readonly COURIER_MAX_CONCURRENT_SHARD_REQUESTS: \"courier:maxConcurrentShardRequests\"; readonly COURIER_BATCH_SEARCHES: \"courier:batchSearches\"; readonly SEARCH_INCLUDE_FROZEN: \"search:includeFrozen\"; readonly SEARCH_TIMEOUT: \"search:timeout\"; readonly HISTOGRAM_BAR_TARGET: \"histogram:barTarget\"; readonly HISTOGRAM_MAX_BARS: \"histogram:maxBars\"; readonly HISTORY_LIMIT: \"history:limit\"; readonly SHORT_DOTS_ENABLE: \"shortDots:enable\"; readonly FORMAT_DEFAULT_TYPE_MAP: \"format:defaultTypeMap\"; readonly FORMAT_NUMBER_DEFAULT_PATTERN: \"format:number:defaultPattern\"; readonly FORMAT_PERCENT_DEFAULT_PATTERN: \"format:percent:defaultPattern\"; readonly FORMAT_BYTES_DEFAULT_PATTERN: \"format:bytes:defaultPattern\"; readonly FORMAT_CURRENCY_DEFAULT_PATTERN: \"format:currency:defaultPattern\"; readonly FORMAT_NUMBER_DEFAULT_LOCALE: \"format:number:defaultLocale\"; readonly TIMEPICKER_REFRESH_INTERVAL_DEFAULTS: \"timepicker:refreshIntervalDefaults\"; readonly TIMEPICKER_QUICK_RANGES: \"timepicker:quickRanges\"; readonly TIMEPICKER_TIME_DEFAULTS: \"timepicker:timeDefaults\"; readonly INDEXPATTERN_PLACEHOLDER: \"indexPattern:placeholder\"; readonly FILTERS_PINNED_BY_DEFAULT: \"filters:pinnedByDefault\"; readonly FILTERS_EDITOR_SUGGEST_VALUES: \"filterEditor:suggestValues\"; readonly AUTOCOMPLETE_USE_TIMERANGE: \"autocomplete:useTimeRange\"; }"],"initialIsOpen":false},{"id":"def-public.AggGroupLabels","type":"Object","children":[{"id":"def-public.AggGroupLabels.[AggGroupNames.Buckets]","type":"string","label":"[AggGroupNames.Buckets]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_groups.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L21"}},{"id":"def-public.AggGroupLabels.[AggGroupNames.Metrics]","type":"string","label":"[AggGroupNames.Metrics]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_groups.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L24"}},{"id":"def-public.AggGroupLabels.[AggGroupNames.None]","type":"string","label":"[AggGroupNames.None]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_groups.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L27"}}],"description":[],"label":"AggGroupLabels","source":{"path":"src/plugins/data/common/search/aggs/agg_groups.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L20"},"initialIsOpen":false},{"id":"def-public.AggGroupNames","type":"Object","label":"AggGroupNames","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_groups.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L12"},"signature":["Readonly<{ Buckets: \"buckets\"; Metrics: \"metrics\"; None: \"none\"; }>"],"initialIsOpen":false},{"id":"def-public.search","type":"Object","children":[{"id":"def-public.search.aggs","type":"Object","children":[{"id":"def-public.search.aggs.CidrMask","type":"Object","label":"CidrMask","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":401,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L401"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.CidrMask","text":"CidrMask"}]},{"id":"def-public.search.aggs.dateHistogramInterval","type":"Function","label":"dateHistogramInterval","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":402,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L402"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.dateHistogramInterval","text":"dateHistogramInterval"}]},{"id":"def-public.search.aggs.intervalOptions","type":"Array","label":"intervalOptions","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":403,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L403"},"signature":["({ display: string; val: string; enabled(agg: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IBucketAggConfig","text":"IBucketAggConfig"},"): boolean | \"\" | undefined; } | { display: string; val: string; })[]"]},{"id":"def-public.search.aggs.InvalidEsCalendarIntervalError","type":"Object","label":"InvalidEsCalendarIntervalError","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":404,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L404"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.InvalidEsCalendarIntervalError","text":"InvalidEsCalendarIntervalError"}]},{"id":"def-public.search.aggs.InvalidEsIntervalFormatError","type":"Object","label":"InvalidEsIntervalFormatError","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":405,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L405"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.InvalidEsIntervalFormatError","text":"InvalidEsIntervalFormatError"}]},{"id":"def-public.search.aggs.Ipv4Address","type":"Object","label":"Ipv4Address","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":406,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L406"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.Ipv4Address","text":"Ipv4Address"}]},{"id":"def-public.search.aggs.isDateHistogramBucketAggConfig","type":"Function","label":"isDateHistogramBucketAggConfig","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":407,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L407"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.isDateHistogramBucketAggConfig","text":"isDateHistogramBucketAggConfig"}]},{"id":"def-public.search.aggs.isNumberType","type":"Function","label":"isNumberType","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":408,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L408"},"signature":["(agg: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},") => boolean"]},{"id":"def-public.search.aggs.isStringType","type":"Function","label":"isStringType","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":409,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L409"},"signature":["(agg: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},") => boolean"]},{"id":"def-public.search.aggs.isType","type":"Function","label":"isType","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":410,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L410"},"signature":["(...types: string[]) => (agg: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},") => boolean"]},{"id":"def-public.search.aggs.isValidEsInterval","type":"Function","label":"isValidEsInterval","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":411,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L411"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.isValidEsInterval","text":"isValidEsInterval"}]},{"id":"def-public.search.aggs.isValidInterval","type":"Function","label":"isValidInterval","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":412,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L412"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.isValidInterval","text":"isValidInterval"}]},{"id":"def-public.search.aggs.parentPipelineType","type":"string","label":"parentPipelineType","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":413,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L413"}},{"id":"def-public.search.aggs.parseEsInterval","type":"Function","label":"parseEsInterval","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":414,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L414"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.parseEsInterval","text":"parseEsInterval"}]},{"id":"def-public.search.aggs.parseInterval","type":"Function","label":"parseInterval","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":415,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L415"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.parseInterval","text":"parseInterval"}]},{"id":"def-public.search.aggs.propFilter","type":"Function","label":"propFilter","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":416,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L416"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.propFilter","text":"propFilter"}]},{"id":"def-public.search.aggs.siblingPipelineType","type":"string","label":"siblingPipelineType","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":417,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L417"}},{"id":"def-public.search.aggs.termsAggFilter","type":"Array","label":"termsAggFilter","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":418,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L418"},"signature":["string[]"]},{"id":"def-public.search.aggs.toAbsoluteDates","type":"Function","label":"toAbsoluteDates","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":419,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L419"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.toAbsoluteDates","text":"toAbsoluteDates"}]},{"id":"def-public.search.aggs.boundsDescendingRaw","type":"Array","label":"boundsDescendingRaw","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":420,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L420"},"signature":["({ bound: number; interval: moment.Duration; boundLabel: string; intervalLabel: string; } | { bound: moment.Duration; interval: moment.Duration; boundLabel: string; intervalLabel: string; })[]"]},{"id":"def-public.search.aggs.getNumberHistogramIntervalByDatatableColumn","type":"Function","label":"getNumberHistogramIntervalByDatatableColumn","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":421,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L421"},"signature":["(column: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.DatatableColumn","text":"DatatableColumn"},") => number | undefined"]}],"description":[],"label":"aggs","source":{"path":"src/plugins/data/public/index.ts","lineNumber":400,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L400"}},{"id":"def-public.search.getRequestInspectorStats","type":"Function","label":"getRequestInspectorStats","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":423,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L423"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.getRequestInspectorStats","text":"getRequestInspectorStats"}]},{"id":"def-public.search.getResponseInspectorStats","type":"Function","label":"getResponseInspectorStats","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":424,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L424"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.getResponseInspectorStats","text":"getResponseInspectorStats"}]},{"id":"def-public.search.tabifyAggResponse","type":"Function","label":"tabifyAggResponse","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":425,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L425"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.tabifyAggResponse","text":"tabifyAggResponse"}]},{"id":"def-public.search.tabifyGetColumns","type":"Function","label":"tabifyGetColumns","description":[],"source":{"path":"src/plugins/data/public/index.ts","lineNumber":426,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L426"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.tabifyGetColumns","text":"tabifyGetColumns"}]}],"description":[],"label":"search","source":{"path":"src/plugins/data/public/index.ts","lineNumber":399,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/index.ts#L399"},"initialIsOpen":false}],"setup":{"id":"def-public.DataPublicPluginSetup","type":"Interface","label":"DataPublicPluginSetup","description":["\nData plugin public Setup contract"],"children":[{"id":"def-public.DataPublicPluginSetup.autocomplete","type":"Object","label":"autocomplete","description":[],"source":{"path":"src/plugins/data/public/types.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L46"},"signature":["{ addQuerySuggestionProvider: (language: string, provider: ",{"pluginId":"data","scope":"public","docId":"kibDataAutocompletePluginApi","section":"def-public.QuerySuggestionGetFn","text":"QuerySuggestionGetFn"},") => void; getQuerySuggestions: ",{"pluginId":"data","scope":"public","docId":"kibDataAutocompletePluginApi","section":"def-public.QuerySuggestionGetFn","text":"QuerySuggestionGetFn"},"; }"]},{"id":"def-public.DataPublicPluginSetup.search","type":"Object","label":"search","description":[],"source":{"path":"src/plugins/data/public/types.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L47"},"signature":[{"pluginId":"data","scope":"public","docId":"kibDataSearchPluginApi","section":"def-public.ISearchSetup","text":"ISearchSetup"}]},{"id":"def-public.DataPublicPluginSetup.fieldFormats","type":"Object","label":"fieldFormats","description":[],"source":{"path":"src/plugins/data/public/types.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L48"},"signature":["Pick<",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatsRegistry","text":"FieldFormatsRegistry"},", \"register\">"]},{"id":"def-public.DataPublicPluginSetup.query","type":"Object","label":"query","description":[],"source":{"path":"src/plugins/data/public/types.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L49"},"signature":["{ filterManager: ",{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.FilterManager","text":"FilterManager"},"; timefilter: ",{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.TimefilterSetup","text":"TimefilterSetup"},"; queryString: Pick<",{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.QueryStringManager","text":"QueryStringManager"},", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; state$: ","Observable","<{ changes: ",{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.QueryStateChange","text":"QueryStateChange"}]},{"id":"def-public.DataPublicPluginSetup.__enhance","type":"Function","label":"__enhance","description":[],"source":{"path":"src/plugins/data/public/types.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L53"},"signature":["(enhancements: ",{"pluginId":"data","scope":"public","docId":"kibDataPluginApi","section":"def-public.DataPublicPluginEnhancements","text":"DataPublicPluginEnhancements"},") => void"]}],"source":{"path":"src/plugins/data/public/types.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L45"},"lifecycle":"setup","initialIsOpen":true},"start":{"id":"def-public.DataPublicPluginStart","type":"Interface","label":"DataPublicPluginStart","description":["\nData plugin public Start contract"],"children":[{"id":"def-public.DataPublicPluginStart.actions","type":"Object","label":"actions","description":["\nfilter creation utilities\n{@link DataPublicPluginStartActions}"],"source":{"path":"src/plugins/data/public/types.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L80"},"signature":[{"pluginId":"data","scope":"public","docId":"kibDataPluginApi","section":"def-public.DataPublicPluginStartActions","text":"DataPublicPluginStartActions"}]},{"id":"def-public.DataPublicPluginStart.autocomplete","type":"Object","label":"autocomplete","description":["\nautocomplete service\n{@link AutocompleteStart}"],"source":{"path":"src/plugins/data/public/types.ts","lineNumber":85,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L85"},"signature":["{ getQuerySuggestions: ",{"pluginId":"data","scope":"public","docId":"kibDataAutocompletePluginApi","section":"def-public.QuerySuggestionGetFn","text":"QuerySuggestionGetFn"},"; hasQuerySuggestions: (language: string) => boolean; getValueSuggestions: ",{"pluginId":"data","scope":"public","docId":"kibDataAutocompletePluginApi","section":"def-public.ValueSuggestionsGetFn","text":"ValueSuggestionsGetFn"},"; }"]},{"id":"def-public.DataPublicPluginStart.indexPatterns","type":"Object","label":"indexPatterns","description":["\nindex patterns service\n{@link IndexPatternsContract}"],"source":{"path":"src/plugins/data/public/types.ts","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L90"},"signature":["Pick<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternsService","text":"IndexPatternsService"},", \"get\" | \"delete\" | \"create\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"find\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">"]},{"id":"def-public.DataPublicPluginStart.search","type":"Object","label":"search","description":["\nsearch service\n{@link ISearchStart}"],"source":{"path":"src/plugins/data/public/types.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L95"},"signature":[{"pluginId":"data","scope":"public","docId":"kibDataSearchPluginApi","section":"def-public.ISearchStart","text":"ISearchStart"}]},{"id":"def-public.DataPublicPluginStart.fieldFormats","type":"CompoundType","label":"fieldFormats","description":["\nfield formats service\n{@link FieldFormatsStart}"],"source":{"path":"src/plugins/data/public/types.ts","lineNumber":100,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L100"},"signature":[{"pluginId":"data","scope":"public","docId":"kibDataFieldFormatsPluginApi","section":"def-public.FieldFormatsStart","text":"FieldFormatsStart"}]},{"id":"def-public.DataPublicPluginStart.query","type":"Object","label":"query","description":["\nquery service\n{@link QueryStart}"],"source":{"path":"src/plugins/data/public/types.ts","lineNumber":105,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L105"},"signature":["{ addToQueryLog: (appName: string, { language, query }: ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.Query","text":"Query"},") => void; filterManager: ",{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.FilterManager","text":"FilterManager"},"; queryString: Pick<",{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.QueryStringManager","text":"QueryStringManager"},", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ",{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.SavedQueryService","text":"SavedQueryService"},"; state$: ","Observable"]},{"id":"def-public.DataPublicPluginStart.ui","type":"Object","label":"ui","description":["\nprewired UI components\n{@link DataPublicPluginStartUi}"],"source":{"path":"src/plugins/data/public/types.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L110"},"signature":[{"pluginId":"data","scope":"public","docId":"kibDataPluginApi","section":"def-public.DataPublicPluginStartUi","text":"DataPublicPluginStartUi"}]},{"id":"def-public.DataPublicPluginStart.nowProvider","type":"Object","label":"nowProvider","description":[],"source":{"path":"src/plugins/data/public/types.ts","lineNumber":112,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L112"},"signature":["Pick, \"get\">"]}],"source":{"path":"src/plugins/data/public/types.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/types.ts#L75"},"lifecycle":"start","initialIsOpen":true}},"server":{"classes":[{"id":"def-server.IndexPattern","type":"Class","label":"IndexPattern","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}," implements ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"}],"children":[{"id":"def-server.IndexPattern.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L45"},"signature":["string | undefined"]},{"id":"def-server.IndexPattern.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L46"}},{"id":"def-server.IndexPattern.fieldFormatMap","type":"Object","label":"fieldFormatMap","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L47"},"signature":["Record"]},{"id":"def-server.IndexPattern.typeMeta","type":"Object","label":"typeMeta","description":["\nOnly used by rollup indices, used by rollup specific endpoint to load field list"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L51"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.TypeMeta","text":"TypeMeta"}," | undefined"]},{"id":"def-server.IndexPattern.fields","type":"CompoundType","label":"fields","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L52"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPatternFieldList","text":"IIndexPatternFieldList"}," & { toSpec: () => Record; }"]},{"id":"def-server.IndexPattern.timeFieldName","type":"string","label":"timeFieldName","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L53"},"signature":["string | undefined"]},{"id":"def-server.IndexPattern.intervalName","type":"string","label":"intervalName","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L58"},"signature":["string | undefined"]},{"id":"def-server.IndexPattern.type","type":"string","label":"type","description":["\nType is used to identify rollup index patterns"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L62"},"signature":["string | undefined"]},{"id":"def-server.IndexPattern.formatHit","type":"Function","label":"formatHit","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L63"},"signature":["{ (hit: Record, type?: string | undefined): any; formatField: FormatFieldFn; }"]},{"id":"def-server.IndexPattern.formatField","type":"Function","label":"formatField","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L67"},"signature":["FormatFieldFn"]},{"id":"def-server.IndexPattern.flattenHit","type":"Function","label":"flattenHit","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L68"},"signature":["(hit: Record, deep?: boolean | undefined) => Record"]},{"id":"def-server.IndexPattern.metaFields","type":"Array","label":"metaFields","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L69"},"signature":["string[]"]},{"id":"def-server.IndexPattern.version","type":"string","label":"version","description":["\nSavedObject version"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L73"},"signature":["string | undefined"]},{"id":"def-server.IndexPattern.sourceFilters","type":"Array","label":"sourceFilters","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L74"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.SourceFilter","text":"SourceFilter"},"[] | undefined"]},{"id":"def-server.IndexPattern.allowNoIndex","type":"boolean","label":"allowNoIndex","description":["\nprevents errors when index pattern exists before indices"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L84"}},{"id":"def-server.IndexPattern.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"{\n spec = {},\n fieldFormats,\n shortDotsEnable = false,\n metaFields = [],\n }","isRequired":true,"signature":["IndexPatternDeps"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L86"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L86"}},{"id":"def-server.IndexPattern.getOriginalSavedObjectBody","type":"Function","children":[],"signature":["() => { fieldAttrs?: string | undefined; title?: string | undefined; timeFieldName?: string | undefined; intervalName?: string | undefined; fields?: string | undefined; sourceFilters?: string | undefined; fieldFormatMap?: string | undefined; typeMeta?: string | undefined; type?: string | undefined; }"],"description":["\nGet last saved saved object fields"],"label":"getOriginalSavedObjectBody","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":128,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L128"},"returnComment":[]},{"id":"def-server.IndexPattern.resetOriginalSavedObjectBody","type":"Function","children":[],"signature":["() => void"],"description":["\nReset last saved saved object fields. used after saving"],"label":"resetOriginalSavedObjectBody","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":133,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L133"},"returnComment":[]},{"id":"def-server.IndexPattern.getFieldAttrs","type":"Function","children":[],"signature":["() => { [x: string]: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldAttrSet","text":"FieldAttrSet"},"; }"],"description":[],"label":"getFieldAttrs","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":137,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L137"},"returnComment":[]},{"id":"def-server.IndexPattern.getComputedFields","type":"Function","label":"getComputedFields","signature":["() => { storedFields: string[]; scriptFields: any; docvalueFields: { field: any; format: string; }[]; runtimeFields: Record; }"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":162,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L162"}},{"id":"def-server.IndexPattern.toSpec","type":"Function","label":"toSpec","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"}],"description":["\nCreate static representation of index pattern"],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":208,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L208"}},{"id":"def-server.IndexPattern.getSourceFiltering","type":"Function","label":"getSourceFiltering","signature":["() => { excludes: any[]; }"],"description":["\nGet the source filtering configuration for that index."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":230,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L230"}},{"id":"def-server.IndexPattern.addScriptedField","type":"Function","label":"addScriptedField","signature":["(name: string, script: string, fieldType?: string) => Promise"],"description":["\nAdd scripted field to field list\n"],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":["field name"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":244,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L244"}},{"type":"string","label":"script","isRequired":true,"signature":["string"],"description":["script code"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":244,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L244"}},{"type":"string","label":"fieldType","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":244,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L244"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":244,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L244"}},{"id":"def-server.IndexPattern.removeScriptedField","type":"Function","label":"removeScriptedField","signature":["(fieldName: string) => void"],"description":["\nRemove scripted field from field list"],"children":[{"type":"string","label":"fieldName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":270,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L270"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":270,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L270"}},{"id":"def-server.IndexPattern.getNonScriptedFields","type":"Function","label":"getNonScriptedFields","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":277,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L277"}},{"id":"def-server.IndexPattern.getScriptedFields","type":"Function","label":"getScriptedFields","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":281,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L281"}},{"id":"def-server.IndexPattern.isTimeBased","type":"Function","label":"isTimeBased","signature":["() => boolean"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":285,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L285"}},{"id":"def-server.IndexPattern.isTimeNanosBased","type":"Function","label":"isTimeNanosBased","signature":["() => boolean"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":289,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L289"}},{"id":"def-server.IndexPattern.getTimeField","type":"Function","label":"getTimeField","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"}," | undefined"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":294,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L294"}},{"id":"def-server.IndexPattern.getFieldByName","type":"Function","label":"getFieldByName","signature":["(name: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"}," | undefined"],"description":[],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":299,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L299"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":299,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L299"}},{"id":"def-server.IndexPattern.getAggregationRestrictions","type":"Function","label":"getAggregationRestrictions","signature":["() => Record> | undefined"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":304,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L304"}},{"id":"def-server.IndexPattern.getAsSavedObjectBody","type":"Function","label":"getAsSavedObjectBody","signature":["() => { fieldAttrs: string | undefined; title: string; timeFieldName: string | undefined; intervalName: string | undefined; sourceFilters: string | undefined; fields: string | undefined; fieldFormatMap: string | undefined; type: string | undefined; typeMeta: string | undefined; allowNoIndex: true | undefined; runtimeFieldMap: string | undefined; }"],"description":["\nReturns index pattern as saved object body for saving"],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":311,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L311"}},{"id":"def-server.IndexPattern.getFormatterForField","type":"Function","label":"getFormatterForField","signature":["(field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"}],"description":["\nProvide a field, get its formatter"],"children":[{"type":"CompoundType","label":"field","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":340,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L340"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":339,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L339"}},{"id":"def-server.IndexPattern.addRuntimeField","type":"Function","label":"addRuntimeField","signature":["(name: string, runtimeField: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.RuntimeField","text":"RuntimeField"},") => void"],"description":["\nAdd a runtime field - Appended to existing mapped field or a new field is\ncreated as appropriate"],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":["Field name"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":360,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L360"}},{"type":"Object","label":"runtimeField","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.RuntimeField","text":"RuntimeField"}],"description":["Runtime field definition"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":360,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L360"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":360,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L360"}},{"id":"def-server.IndexPattern.removeRuntimeField","type":"Function","label":"removeRuntimeField","signature":["(name: string) => void"],"description":["\nRemove a runtime field - removed from mapped field or removed unmapped\nfield as appropriate"],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":["Field name"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":384,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L384"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":384,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L384"}},{"id":"def-server.IndexPattern.getFormatterForFieldNoDefault","type":"Function","label":"getFormatterForFieldNoDefault","signature":["(fieldname: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"}," | undefined"],"description":["\nGet formatter for a given field name. Return undefined if none exists"],"children":[{"type":"string","label":"fieldname","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":404,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L404"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":404,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L404"}},{"id":"def-server.IndexPattern.setFieldAttrs","type":"Function","label":"setFieldAttrs","signature":["(fieldName: string, attrName: K, value: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldAttrSet","text":"FieldAttrSet"},"[K]) => void"],"description":[],"children":[{"type":"string","label":"fieldName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":412,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L412"}},{"type":"Uncategorized","label":"attrName","isRequired":true,"signature":["K"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":413,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L413"}},{"type":"Uncategorized","label":"value","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldAttrSet","text":"FieldAttrSet"},"[K]"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":414,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L414"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":411,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L411"}},{"id":"def-server.IndexPattern.setFieldCustomLabel","type":"Function","label":"setFieldCustomLabel","signature":["(fieldName: string, customLabel: string | null | undefined) => void"],"description":[],"children":[{"type":"string","label":"fieldName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":422,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L422"}},{"type":"CompoundType","label":"customLabel","isRequired":false,"signature":["string | null | undefined"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":422,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L422"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":422,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L422"}},{"id":"def-server.IndexPattern.setFieldCount","type":"Function","label":"setFieldCount","signature":["(fieldName: string, count: number | null | undefined) => void"],"description":[],"children":[{"type":"string","label":"fieldName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":433,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L433"}},{"type":"CompoundType","label":"count","isRequired":false,"signature":["number | null | undefined"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":433,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L433"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":433,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L433"}},{"id":"def-server.IndexPattern.setFieldFormat","type":"Function","children":[{"type":"string","label":"fieldName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":446,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L446"}},{"type":"Object","label":"format","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializedFieldFormat","text":"SerializedFieldFormat"},">"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":446,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L446"}}],"signature":["(fieldName: string, format: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializedFieldFormat","text":"SerializedFieldFormat"},">) => void"],"description":[],"label":"setFieldFormat","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":446,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L446"},"returnComment":[]},{"id":"def-server.IndexPattern.deleteFieldFormat","type":"Function","children":[{"type":"string","label":"fieldName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":450,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L450"}}],"signature":["(fieldName: string) => void"],"description":[],"label":"deleteFieldFormat","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":450,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L450"},"returnComment":[]}],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L44"},"initialIsOpen":false},{"id":"def-server.IndexPatternsService","type":"Class","label":"IndexPatternsService","description":[],"children":[{"id":"def-server.IndexPatternsService.ensureDefaultIndexPattern","type":"Function","label":"ensureDefaultIndexPattern","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L67"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.EnsureDefaultIndexPattern","text":"EnsureDefaultIndexPattern"}]},{"id":"def-server.IndexPatternsService.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"{\n uiSettings,\n savedObjectsClient,\n apiClient,\n fieldFormats,\n onNotification,\n onError,\n onRedirectNoIndexPattern = () => {},\n }","isRequired":true,"signature":["IndexPatternsServiceDeps"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L69"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L69"}},{"id":"def-server.IndexPatternsService.getIds","type":"Function","children":[{"type":"boolean","label":"refresh","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L108"}}],"signature":["(refresh?: boolean) => Promise"],"description":["\nGet list of index pattern ids"],"label":"getIds","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L108"},"returnComment":[]},{"id":"def-server.IndexPatternsService.getTitles","type":"Function","children":[{"type":"boolean","label":"refresh","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":122,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L122"}}],"signature":["(refresh?: boolean) => Promise"],"description":["\nGet list of index pattern titles"],"label":"getTitles","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":122,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L122"},"returnComment":[]},{"id":"def-server.IndexPatternsService.find","type":"Function","children":[{"type":"string","label":"search","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":138,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L138"}},{"type":"number","label":"size","isRequired":true,"signature":["number"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":138,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L138"}}],"signature":["(search: string, size?: number) => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},"[]>"],"description":["\nFind and load index patterns by title"],"label":"find","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":138,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L138"},"returnComment":["IndexPattern[]"]},{"id":"def-server.IndexPatternsService.getIdsWithTitle","type":"Function","children":[{"type":"boolean","label":"refresh","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":157,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L157"}}],"signature":["(refresh?: boolean) => Promise<{ id: string; title: string; }[]>"],"description":["\nGet list of index pattern ids with titles"],"label":"getIdsWithTitle","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":156,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L156"},"returnComment":[]},{"id":"def-server.IndexPatternsService.clearCache","type":"Function","children":[{"type":"string","label":"id","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":175,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L175"}}],"signature":["(id?: string | undefined) => void"],"description":["\nClear index pattern list cache"],"label":"clearCache","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":175,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L175"},"returnComment":[]},{"id":"def-server.IndexPatternsService.getCache","type":"Function","children":[],"signature":["() => Promise<",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},"<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSavedObjectAttrs","text":"IndexPatternSavedObjectAttrs"},">[] | null | undefined>"],"description":[],"label":"getCache","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":184,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L184"},"returnComment":[]},{"id":"def-server.IndexPatternsService.getDefault","type":"Function","children":[],"signature":["() => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}," | null>"],"description":["\nGet default index pattern"],"label":"getDefault","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":194,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L194"},"returnComment":[]},{"id":"def-server.IndexPatternsService.setDefault","type":"Function","children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":208,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L208"}},{"type":"boolean","label":"force","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":208,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L208"}}],"signature":["(id: string, force?: boolean) => Promise"],"description":["\nOptionally set default index pattern, unless force = true"],"label":"setDefault","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":208,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L208"},"returnComment":[]},{"id":"def-server.IndexPatternsService.getFieldsForWildcard","type":"Function","children":[{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.GetFieldsOptions","text":"GetFieldsOptions"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":219,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L219"}}],"signature":["(options: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.GetFieldsOptions","text":"GetFieldsOptions"},") => Promise"],"description":["\nGet field list by providing { pattern }"],"label":"getFieldsForWildcard","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":219,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L219"},"returnComment":["FieldSpec[]"]},{"id":"def-server.IndexPatternsService.getFieldsForIndexPattern","type":"Function","children":[{"type":"CompoundType","label":"indexPattern","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":236,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L236"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.GetFieldsOptions","text":"GetFieldsOptions"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":237,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L237"}}],"signature":["(indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"},", options?: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.GetFieldsOptions","text":"GetFieldsOptions"}," | undefined) => Promise"],"description":["\nGet field list by providing an index patttern (or spec)"],"label":"getFieldsForIndexPattern","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":235,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L235"},"returnComment":["FieldSpec[]"]},{"id":"def-server.IndexPatternsService.refreshFields","type":"Function","children":[{"type":"Object","label":"indexPattern","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":250,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L250"}}],"signature":["(indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},") => Promise"],"description":["\nRefresh field list for a given index pattern"],"label":"refreshFields","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":250,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L250"},"returnComment":[]},{"id":"def-server.IndexPatternsService.fieldArrayToMap","type":"Function","children":[{"type":"Array","label":"fields","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},"[]"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":327,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L327"}},{"type":"Object","label":"fieldAttrs","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldAttrs","text":"FieldAttrs"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":327,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L327"}}],"signature":["(fields: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},"[], fieldAttrs?: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldAttrs","text":"FieldAttrs"}," | undefined) => Record"],"description":["\nConverts field array to map"],"label":"fieldArrayToMap","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":327,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L327"},"returnComment":["Record"]},{"id":"def-server.IndexPatternsService.savedObjectToSpec","type":"Function","children":[{"type":"Object","label":"savedObject","isRequired":true,"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},"<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternAttributes","text":"IndexPatternAttributes"},">"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":343,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L343"}}],"signature":["(savedObject: ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},"<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternAttributes","text":"IndexPatternAttributes"},">) => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"}],"description":["\nConverts index pattern saved object to index pattern spec"],"label":"savedObjectToSpec","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":343,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L343"},"returnComment":["IndexPatternSpec"]},{"id":"def-server.IndexPatternsService.get","type":"Function","children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":464,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L464"}}],"signature":["(id: string) => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},">"],"description":["\nGet an index pattern by id. Cache optimized"],"label":"get","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":464,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L464"},"returnComment":[]},{"id":"def-server.IndexPatternsService.create","type":"Function","label":"create","signature":["(spec: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"},", skipFetchFields?: boolean) => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},">"],"description":["\nCreate a new index pattern instance"],"children":[{"type":"Object","label":"spec","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":483,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L483"}},{"type":"boolean","label":"skipFetchFields","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":483,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L483"}}],"tags":[],"returnComment":["IndexPattern"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":483,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L483"}},{"id":"def-server.IndexPatternsService.createAndSave","type":"Function","label":"createAndSave","signature":["(spec: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"},", override?: boolean, skipFetchFields?: boolean) => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},">"],"description":["\nCreate a new index pattern and save it right away"],"children":[{"type":"Object","label":"spec","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":508,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508"}},{"type":"boolean","label":"override","isRequired":true,"signature":["boolean"],"description":["Overwrite if existing index pattern exists."],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":508,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508"}},{"type":"boolean","label":"skipFetchFields","isRequired":true,"signature":["boolean"],"description":["Whether to skip field refresh step."],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":508,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":508,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508"}},{"id":"def-server.IndexPatternsService.createSavedObject","type":"Function","label":"createSavedObject","signature":["(indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},", override?: boolean) => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},">"],"description":["\nSave a new index pattern"],"children":[{"type":"Object","label":"indexPattern","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":521,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L521"}},{"type":"boolean","label":"override","isRequired":true,"signature":["boolean"],"description":["Overwrite if existing index pattern exists"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":521,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L521"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":521,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L521"}},{"id":"def-server.IndexPatternsService.updateSavedObject","type":"Function","label":"updateSavedObject","signature":["(indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},", saveAttempts?: number, ignoreErrors?: boolean) => Promise"],"description":["\nSave existing index pattern. Will attempt to merge differences if there are conflicts"],"children":[{"type":"Object","label":"indexPattern","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":547,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L547"}},{"type":"number","label":"saveAttempts","isRequired":true,"signature":["number"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":548,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L548"}},{"type":"boolean","label":"ignoreErrors","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":549,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L549"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":546,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L546"}},{"id":"def-server.IndexPatternsService.delete","type":"Function","label":"delete","signature":["(indexPatternId: string) => Promise<{}>"],"description":["\nDeletes an index pattern from .kibana index"],"children":[{"type":"string","label":"indexPatternId","isRequired":true,"signature":["string"],"description":[": Id of kibana Index Pattern to delete"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":632,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L632"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":632,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L632"}}],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L57"},"initialIsOpen":false},{"id":"def-server.IndexPatternsService","type":"Class","label":"IndexPatternsService","description":[],"children":[{"id":"def-server.IndexPatternsService.ensureDefaultIndexPattern","type":"Function","label":"ensureDefaultIndexPattern","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L67"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.EnsureDefaultIndexPattern","text":"EnsureDefaultIndexPattern"}]},{"id":"def-server.IndexPatternsService.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"{\n uiSettings,\n savedObjectsClient,\n apiClient,\n fieldFormats,\n onNotification,\n onError,\n onRedirectNoIndexPattern = () => {},\n }","isRequired":true,"signature":["IndexPatternsServiceDeps"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L69"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L69"}},{"id":"def-server.IndexPatternsService.getIds","type":"Function","children":[{"type":"boolean","label":"refresh","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L108"}}],"signature":["(refresh?: boolean) => Promise"],"description":["\nGet list of index pattern ids"],"label":"getIds","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L108"},"returnComment":[]},{"id":"def-server.IndexPatternsService.getTitles","type":"Function","children":[{"type":"boolean","label":"refresh","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":122,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L122"}}],"signature":["(refresh?: boolean) => Promise"],"description":["\nGet list of index pattern titles"],"label":"getTitles","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":122,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L122"},"returnComment":[]},{"id":"def-server.IndexPatternsService.find","type":"Function","children":[{"type":"string","label":"search","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":138,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L138"}},{"type":"number","label":"size","isRequired":true,"signature":["number"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":138,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L138"}}],"signature":["(search: string, size?: number) => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},"[]>"],"description":["\nFind and load index patterns by title"],"label":"find","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":138,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L138"},"returnComment":["IndexPattern[]"]},{"id":"def-server.IndexPatternsService.getIdsWithTitle","type":"Function","children":[{"type":"boolean","label":"refresh","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":157,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L157"}}],"signature":["(refresh?: boolean) => Promise<{ id: string; title: string; }[]>"],"description":["\nGet list of index pattern ids with titles"],"label":"getIdsWithTitle","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":156,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L156"},"returnComment":[]},{"id":"def-server.IndexPatternsService.clearCache","type":"Function","children":[{"type":"string","label":"id","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":175,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L175"}}],"signature":["(id?: string | undefined) => void"],"description":["\nClear index pattern list cache"],"label":"clearCache","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":175,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L175"},"returnComment":[]},{"id":"def-server.IndexPatternsService.getCache","type":"Function","children":[],"signature":["() => Promise<",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},"<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSavedObjectAttrs","text":"IndexPatternSavedObjectAttrs"},">[] | null | undefined>"],"description":[],"label":"getCache","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":184,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L184"},"returnComment":[]},{"id":"def-server.IndexPatternsService.getDefault","type":"Function","children":[],"signature":["() => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}," | null>"],"description":["\nGet default index pattern"],"label":"getDefault","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":194,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L194"},"returnComment":[]},{"id":"def-server.IndexPatternsService.setDefault","type":"Function","children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":208,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L208"}},{"type":"boolean","label":"force","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":208,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L208"}}],"signature":["(id: string, force?: boolean) => Promise"],"description":["\nOptionally set default index pattern, unless force = true"],"label":"setDefault","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":208,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L208"},"returnComment":[]},{"id":"def-server.IndexPatternsService.getFieldsForWildcard","type":"Function","children":[{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.GetFieldsOptions","text":"GetFieldsOptions"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":219,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L219"}}],"signature":["(options: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.GetFieldsOptions","text":"GetFieldsOptions"},") => Promise"],"description":["\nGet field list by providing { pattern }"],"label":"getFieldsForWildcard","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":219,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L219"},"returnComment":["FieldSpec[]"]},{"id":"def-server.IndexPatternsService.getFieldsForIndexPattern","type":"Function","children":[{"type":"CompoundType","label":"indexPattern","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":236,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L236"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.GetFieldsOptions","text":"GetFieldsOptions"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":237,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L237"}}],"signature":["(indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"},", options?: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.GetFieldsOptions","text":"GetFieldsOptions"}," | undefined) => Promise"],"description":["\nGet field list by providing an index patttern (or spec)"],"label":"getFieldsForIndexPattern","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":235,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L235"},"returnComment":["FieldSpec[]"]},{"id":"def-server.IndexPatternsService.refreshFields","type":"Function","children":[{"type":"Object","label":"indexPattern","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":250,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L250"}}],"signature":["(indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},") => Promise"],"description":["\nRefresh field list for a given index pattern"],"label":"refreshFields","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":250,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L250"},"returnComment":[]},{"id":"def-server.IndexPatternsService.fieldArrayToMap","type":"Function","children":[{"type":"Array","label":"fields","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},"[]"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":327,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L327"}},{"type":"Object","label":"fieldAttrs","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldAttrs","text":"FieldAttrs"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":327,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L327"}}],"signature":["(fields: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},"[], fieldAttrs?: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldAttrs","text":"FieldAttrs"}," | undefined) => Record"],"description":["\nConverts field array to map"],"label":"fieldArrayToMap","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":327,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L327"},"returnComment":["Record"]},{"id":"def-server.IndexPatternsService.savedObjectToSpec","type":"Function","children":[{"type":"Object","label":"savedObject","isRequired":true,"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},"<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternAttributes","text":"IndexPatternAttributes"},">"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":343,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L343"}}],"signature":["(savedObject: ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},"<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternAttributes","text":"IndexPatternAttributes"},">) => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"}],"description":["\nConverts index pattern saved object to index pattern spec"],"label":"savedObjectToSpec","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":343,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L343"},"returnComment":["IndexPatternSpec"]},{"id":"def-server.IndexPatternsService.get","type":"Function","children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":464,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L464"}}],"signature":["(id: string) => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},">"],"description":["\nGet an index pattern by id. Cache optimized"],"label":"get","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":464,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L464"},"returnComment":[]},{"id":"def-server.IndexPatternsService.create","type":"Function","label":"create","signature":["(spec: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"},", skipFetchFields?: boolean) => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},">"],"description":["\nCreate a new index pattern instance"],"children":[{"type":"Object","label":"spec","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":483,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L483"}},{"type":"boolean","label":"skipFetchFields","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":483,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L483"}}],"tags":[],"returnComment":["IndexPattern"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":483,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L483"}},{"id":"def-server.IndexPatternsService.createAndSave","type":"Function","label":"createAndSave","signature":["(spec: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"},", override?: boolean, skipFetchFields?: boolean) => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},">"],"description":["\nCreate a new index pattern and save it right away"],"children":[{"type":"Object","label":"spec","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":508,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508"}},{"type":"boolean","label":"override","isRequired":true,"signature":["boolean"],"description":["Overwrite if existing index pattern exists."],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":508,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508"}},{"type":"boolean","label":"skipFetchFields","isRequired":true,"signature":["boolean"],"description":["Whether to skip field refresh step."],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":508,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":508,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508"}},{"id":"def-server.IndexPatternsService.createSavedObject","type":"Function","label":"createSavedObject","signature":["(indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},", override?: boolean) => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},">"],"description":["\nSave a new index pattern"],"children":[{"type":"Object","label":"indexPattern","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":521,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L521"}},{"type":"boolean","label":"override","isRequired":true,"signature":["boolean"],"description":["Overwrite if existing index pattern exists"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":521,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L521"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":521,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L521"}},{"id":"def-server.IndexPatternsService.updateSavedObject","type":"Function","label":"updateSavedObject","signature":["(indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},", saveAttempts?: number, ignoreErrors?: boolean) => Promise"],"description":["\nSave existing index pattern. Will attempt to merge differences if there are conflicts"],"children":[{"type":"Object","label":"indexPattern","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":547,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L547"}},{"type":"number","label":"saveAttempts","isRequired":true,"signature":["number"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":548,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L548"}},{"type":"boolean","label":"ignoreErrors","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":549,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L549"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":546,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L546"}},{"id":"def-server.IndexPatternsService.delete","type":"Function","label":"delete","signature":["(indexPatternId: string) => Promise<{}>"],"description":["\nDeletes an index pattern from .kibana index"],"children":[{"type":"string","label":"indexPatternId","isRequired":true,"signature":["string"],"description":[": Id of kibana Index Pattern to delete"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":632,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L632"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":632,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L632"}}],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L57"},"initialIsOpen":false},{"id":"def-server.AggParamType","type":"Class","label":"AggParamType","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamType","text":"AggParamType"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseParamType","text":"BaseParamType"},""],"children":[{"id":"def-server.AggParamType.makeAgg","type":"Function","label":"makeAgg","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/agg.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/agg.ts#L15"},"signature":["(agg: TAggConfig, state?: { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined; schema?: string | undefined; } | undefined) => TAggConfig"]},{"id":"def-server.AggParamType.allowedAggs","type":"Array","label":"allowedAggs","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/agg.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/agg.ts#L16"},"signature":["string[]"]},{"id":"def-server.AggParamType.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"config","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/agg.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/agg.ts#L18"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/agg.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/agg.ts#L18"}}],"source":{"path":"src/plugins/data/common/search/aggs/param_types/agg.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/agg.ts#L12"},"initialIsOpen":false},{"id":"def-server.OptionedParamType","type":"Class","label":"OptionedParamType","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.OptionedParamType","text":"OptionedParamType"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseParamType","text":"BaseParamType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},">"],"children":[{"id":"def-server.OptionedParamType.options","type":"Array","label":"options","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/optioned.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L20"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.OptionedValueProp","text":"OptionedValueProp"},"[]"]},{"id":"def-server.OptionedParamType.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"config","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/optioned.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L22"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/optioned.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L22"}}],"source":{"path":"src/plugins/data/common/search/aggs/param_types/optioned.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L19"},"initialIsOpen":false},{"id":"def-server.DataServerPlugin","type":"Class","label":"DataServerPlugin","description":[],"signature":[{"pluginId":"data","scope":"server","docId":"kibDataPluginApi","section":"def-server.DataServerPlugin","text":"DataServerPlugin"}," implements ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.Plugin","text":"Plugin"},"<",{"pluginId":"data","scope":"server","docId":"kibDataPluginApi","section":"def-server.DataPluginSetup","text":"DataPluginSetup"},", ",{"pluginId":"data","scope":"server","docId":"kibDataPluginApi","section":"def-server.DataPluginStart","text":"DataPluginStart"},", ","DataPluginSetupDependencies"],"children":[{"id":"def-server.DataServerPlugin.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"initializerContext","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.PluginInitializerContext","text":"PluginInitializerContext"},"; }>; }>; autocomplete: Readonly<{} & { querySuggestions: Readonly<{} & { enabled: boolean; }>; valueSuggestions: Readonly<{} & { enabled: boolean; }>; }>; }>>"],"description":[],"source":{"path":"src/plugins/data/server/plugin.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L69"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/server/plugin.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L69"}},{"id":"def-server.DataServerPlugin.setup","type":"Function","label":"setup","signature":["(core: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreSetup","text":"CoreSetup"},"<",{"pluginId":"data","scope":"server","docId":"kibDataPluginApi","section":"def-server.DataPluginStartDependencies","text":"DataPluginStartDependencies"},", ",{"pluginId":"data","scope":"server","docId":"kibDataPluginApi","section":"def-server.DataPluginStart","text":"DataPluginStart"},">, { bfetch, expressions, usageCollection }: ",{"pluginId":"data","scope":"server","docId":"kibDataPluginApi","section":"def-server.DataPluginSetupDependencies","text":"DataPluginSetupDependencies"},") => { __enhance: (enhancements: ",{"pluginId":"data","scope":"server","docId":"kibDataPluginApi","section":"def-server.DataEnhancements","text":"DataEnhancements"}],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreSetup","text":"CoreSetup"},"<",{"pluginId":"data","scope":"server","docId":"kibDataPluginApi","section":"def-server.DataPluginStartDependencies","text":"DataPluginStartDependencies"},", ",{"pluginId":"data","scope":"server","docId":"kibDataPluginApi","section":"def-server.DataPluginStart","text":"DataPluginStart"},">"],"description":[],"source":{"path":"src/plugins/data/server/plugin.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L78"}},{"type":"Object","label":"{ bfetch, expressions, usageCollection }","isRequired":true,"signature":[{"pluginId":"data","scope":"server","docId":"kibDataPluginApi","section":"def-server.DataPluginSetupDependencies","text":"DataPluginSetupDependencies"}],"description":[],"source":{"path":"src/plugins/data/server/plugin.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L79"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/server/plugin.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L77"}},{"id":"def-server.DataServerPlugin.start","type":"Function","label":"start","signature":["(core: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreStart","text":"CoreStart"},") => { fieldFormats: { fieldFormatServiceFactory: (uiSettings: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.IUiSettingsClient","text":"IUiSettingsClient"},") => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatsRegistry","text":"FieldFormatsRegistry"},">; }; indexPatterns: { indexPatternsServiceFactory: (savedObjectsClient: Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">, elasticsearchClient: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ElasticsearchClient","text":"ElasticsearchClient"}],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreStart","text":"CoreStart"}],"description":[],"source":{"path":"src/plugins/data/server/plugin.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L104"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/server/plugin.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L104"}},{"id":"def-server.DataServerPlugin.stop","type":"Function","label":"stop","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/server/plugin.ts","lineNumber":118,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L118"}}],"source":{"path":"src/plugins/data/server/plugin.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L52"},"initialIsOpen":false}],"functions":[{"id":"def-server.castEsToKbnFieldTypeName","type":"Function","children":[{"type":"string","label":"esType","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/kbn_field_types/kbn_field_types.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_types.ts#L39"}}],"signature":["(esType: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"}],"description":["\n Get the KbnFieldType name for an esType string\n"],"label":"castEsToKbnFieldTypeName","source":{"path":"src/plugins/data/common/kbn_field_types/kbn_field_types.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_types.ts#L39"},"returnComment":[],"initialIsOpen":false},{"id":"def-server.getTime","type":"Function","label":"getTime","signature":["(indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"}," | undefined, timeRange: ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"},", options: { forceNow?: Date | undefined; fieldName?: string | undefined; } | undefined) => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.RangeFilter","text":"RangeFilter"}," | undefined"],"description":[],"children":[{"type":"Object","label":"indexPattern","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/query/timefilter/get_time.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L38"}},{"type":"Object","label":"timeRange","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"}],"description":[],"source":{"path":"src/plugins/data/common/query/timefilter/get_time.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L39"}},{"id":"def-server.getTime.options","type":"Object","label":"options","description":[],"children":[{"id":"def-server.getTime.options.forceNow","type":"Object","label":"forceNow","description":[],"source":{"path":"src/plugins/data/common/query/timefilter/get_time.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L40"},"signature":["Date | undefined"]},{"id":"def-server.getTime.options.fieldName","type":"string","label":"fieldName","description":[],"source":{"path":"src/plugins/data/common/query/timefilter/get_time.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L40"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/data/common/query/timefilter/get_time.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L40"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/query/timefilter/get_time.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L37"},"initialIsOpen":false},{"id":"def-server.parseInterval","type":"Function","label":"parseInterval","signature":["(interval: string) => moment.Duration | null"],"description":[],"children":[{"type":"string","label":"interval","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts#L29"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts#L29"},"initialIsOpen":false}],"interfaces":[{"id":"def-server.EsQueryConfig","type":"Interface","label":"EsQueryConfig","description":[],"children":[{"id":"def-server.EsQueryConfig.allowLeadingWildcards","type":"boolean","label":"allowLeadingWildcards","description":[],"source":{"path":"src/plugins/data/common/es_query/es_query/build_es_query.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L18"}},{"id":"def-server.EsQueryConfig.queryStringOptions","type":"Object","label":"queryStringOptions","description":[],"source":{"path":"src/plugins/data/common/es_query/es_query/build_es_query.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L19"},"signature":["Record"]},{"id":"def-server.EsQueryConfig.ignoreFilterIfFieldNotInIndex","type":"boolean","label":"ignoreFilterIfFieldNotInIndex","description":[],"source":{"path":"src/plugins/data/common/es_query/es_query/build_es_query.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L20"}},{"id":"def-server.EsQueryConfig.dateFormatTZ","type":"string","label":"dateFormatTZ","description":[],"source":{"path":"src/plugins/data/common/es_query/es_query/build_es_query.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L21"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/data/common/es_query/es_query/build_es_query.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L17"},"initialIsOpen":false},{"id":"def-server.KueryNode","type":"Interface","label":"KueryNode","description":[],"children":[{"id":"def-server.KueryNode.type","type":"CompoundType","label":"type","description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/types.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L12"},"signature":["\"function\" | \"literal\" | \"namedArg\" | \"wildcard\""]},{"id":"def-server.KueryNode.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L13"},"signature":["any"]}],"source":{"path":"src/plugins/data/common/es_query/kuery/types.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L11"},"initialIsOpen":false},{"id":"def-server.FieldFormatConfig","type":"Interface","label":"FieldFormatConfig","description":[],"children":[{"id":"def-server.FieldFormatConfig.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/data/common/field_formats/types.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L62"}},{"id":"def-server.FieldFormatConfig.params","type":"Object","label":"params","description":[],"source":{"path":"src/plugins/data/common/field_formats/types.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L63"},"signature":["Record"]},{"id":"def-server.FieldFormatConfig.es","type":"CompoundType","label":"es","description":[],"source":{"path":"src/plugins/data/common/field_formats/types.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L64"},"signature":["boolean | undefined"]}],"source":{"path":"src/plugins/data/common/field_formats/types.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L61"},"initialIsOpen":false},{"id":"def-server.IFieldType","type":"Interface","label":"IFieldType","description":[],"children":[{"id":"def-server.IFieldType.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L12"}},{"id":"def-server.IFieldType.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L13"}},{"id":"def-server.IFieldType.script","type":"string","label":"script","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L14"},"signature":["string | undefined"]},{"id":"def-server.IFieldType.lang","type":"string","label":"lang","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L15"},"signature":["string | undefined"]},{"id":"def-server.IFieldType.count","type":"number","label":"count","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L16"},"signature":["number | undefined"]},{"id":"def-server.IFieldType.esTypes","type":"Array","label":"esTypes","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L19"},"signature":["string[] | undefined"]},{"id":"def-server.IFieldType.aggregatable","type":"CompoundType","label":"aggregatable","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L20"},"signature":["boolean | undefined"]},{"id":"def-server.IFieldType.filterable","type":"CompoundType","label":"filterable","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L21"},"signature":["boolean | undefined"]},{"id":"def-server.IFieldType.searchable","type":"CompoundType","label":"searchable","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L22"},"signature":["boolean | undefined"]},{"id":"def-server.IFieldType.sortable","type":"CompoundType","label":"sortable","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L23"},"signature":["boolean | undefined"]},{"id":"def-server.IFieldType.visualizable","type":"CompoundType","label":"visualizable","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L24"},"signature":["boolean | undefined"]},{"id":"def-server.IFieldType.readFromDocValues","type":"CompoundType","label":"readFromDocValues","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L25"},"signature":["boolean | undefined"]},{"id":"def-server.IFieldType.scripted","type":"CompoundType","label":"scripted","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L26"},"signature":["boolean | undefined"]},{"id":"def-server.IFieldType.subType","type":"Object","label":"subType","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L27"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldSubType","text":"IFieldSubType"}," | undefined"]},{"id":"def-server.IFieldType.displayName","type":"string","label":"displayName","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L28"},"signature":["string | undefined"]},{"id":"def-server.IFieldType.customLabel","type":"string","label":"customLabel","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L29"},"signature":["string | undefined"]},{"id":"def-server.IFieldType.format","type":"Any","label":"format","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L30"},"signature":["any"]},{"id":"def-server.IFieldType.toSpec","type":"Function","label":"toSpec","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L31"},"signature":["((options?: { getFormatterForField?: ((field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"},") | undefined; } | undefined) => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"}]}],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L11"},"initialIsOpen":false},{"id":"def-server.IFieldSubType","type":"Interface","label":"IFieldSubType","description":[],"children":[{"id":"def-server.IFieldSubType.multi","type":"Object","label":"multi","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":154,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L154"},"signature":["{ parent: string; } | undefined"]},{"id":"def-server.IFieldSubType.nested","type":"Object","label":"nested","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":155,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L155"},"signature":["{ path: string; } | undefined"]}],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":153,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L153"},"initialIsOpen":false},{"id":"def-server.IndexPatternAttributes","type":"Interface","label":"IndexPatternAttributes","description":["\nInterface for an index pattern saved object"],"children":[{"id":"def-server.IndexPatternAttributes.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L54"}},{"id":"def-server.IndexPatternAttributes.fields","type":"string","label":"fields","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L55"}},{"id":"def-server.IndexPatternAttributes.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L56"}},{"id":"def-server.IndexPatternAttributes.typeMeta","type":"string","label":"typeMeta","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L57"}},{"id":"def-server.IndexPatternAttributes.timeFieldName","type":"string","label":"timeFieldName","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L58"},"signature":["string | undefined"]},{"id":"def-server.IndexPatternAttributes.intervalName","type":"string","label":"intervalName","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L59"},"signature":["string | undefined"]},{"id":"def-server.IndexPatternAttributes.sourceFilters","type":"string","label":"sourceFilters","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L60"},"signature":["string | undefined"]},{"id":"def-server.IndexPatternAttributes.fieldFormatMap","type":"string","label":"fieldFormatMap","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L61"},"signature":["string | undefined"]},{"id":"def-server.IndexPatternAttributes.fieldAttrs","type":"string","label":"fieldAttrs","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L62"},"signature":["string | undefined"]},{"id":"def-server.IndexPatternAttributes.runtimeFieldMap","type":"string","label":"runtimeFieldMap","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L63"},"signature":["string | undefined"]},{"id":"def-server.IndexPatternAttributes.allowNoIndex","type":"CompoundType","label":"allowNoIndex","description":["\nprevents errors when index pattern exists before indices"],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L67"},"signature":["boolean | undefined"]}],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L53"},"initialIsOpen":false},{"id":"def-server.AggFunctionsMapping","type":"Interface","label":"AggFunctionsMapping","description":["\nA global list of the expression function definitions for each agg type function."],"children":[{"id":"def-server.AggFunctionsMapping.aggFilter","type":"Object","label":"aggFilter","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":204,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L204"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggFilters","type":"Object","label":"aggFilters","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":205,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L205"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggSignificantTerms","type":"Object","label":"aggSignificantTerms","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":206,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L206"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggIpRange","type":"Object","label":"aggIpRange","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":207,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L207"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggDateRange","type":"Object","label":"aggDateRange","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":208,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L208"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggRange","type":"Object","label":"aggRange","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":209,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L209"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggGeoTile","type":"Object","label":"aggGeoTile","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":210,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L210"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggGeoHash","type":"Object","label":"aggGeoHash","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":211,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L211"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggHistogram","type":"Object","label":"aggHistogram","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":212,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L212"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggDateHistogram","type":"Object","label":"aggDateHistogram","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":213,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L213"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggTerms","type":"Object","label":"aggTerms","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":214,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L214"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggAvg","type":"Object","label":"aggAvg","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":215,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L215"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggBucketAvg","type":"Object","label":"aggBucketAvg","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":216,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L216"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggBucketMax","type":"Object","label":"aggBucketMax","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":217,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L217"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggBucketMin","type":"Object","label":"aggBucketMin","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":218,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L218"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggBucketSum","type":"Object","label":"aggBucketSum","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":219,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L219"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggCardinality","type":"Object","label":"aggCardinality","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":220,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L220"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggCount","type":"Object","label":"aggCount","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":221,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L221"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggCumulativeSum","type":"Object","label":"aggCumulativeSum","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":222,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L222"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggDerivative","type":"Object","label":"aggDerivative","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":223,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L223"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggGeoBounds","type":"Object","label":"aggGeoBounds","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":224,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L224"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggGeoCentroid","type":"Object","label":"aggGeoCentroid","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":225,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L225"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggMax","type":"Object","label":"aggMax","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":226,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L226"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggMedian","type":"Object","label":"aggMedian","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":227,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L227"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggMin","type":"Object","label":"aggMin","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":228,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L228"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggMovingAvg","type":"Object","label":"aggMovingAvg","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":229,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L229"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggPercentileRanks","type":"Object","label":"aggPercentileRanks","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":230,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L230"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggPercentiles","type":"Object","label":"aggPercentiles","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":231,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L231"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggSerialDiff","type":"Object","label":"aggSerialDiff","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":232,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L232"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggStdDeviation","type":"Object","label":"aggStdDeviation","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":233,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L233"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggSum","type":"Object","label":"aggSum","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":234,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L234"},"signature":["FunctionDefinition"]},{"id":"def-server.AggFunctionsMapping.aggTopHit","type":"Object","label":"aggTopHit","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":235,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L235"},"signature":["FunctionDefinition"]}],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":203,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L203"},"initialIsOpen":false},{"id":"def-server.AggParamOption","type":"Interface","label":"AggParamOption","description":[],"children":[{"id":"def-server.AggParamOption.val","type":"string","label":"val","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_params.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L31"}},{"id":"def-server.AggParamOption.display","type":"string","label":"display","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_params.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L32"}},{"id":"def-server.AggParamOption.enabled","type":"Function","label":"enabled","signature":["((agg: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},") => boolean) | undefined"],"description":[],"children":[{"type":"Object","label":"agg","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"}],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_params.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L33"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_params.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L33"}}],"source":{"path":"src/plugins/data/common/search/aggs/agg_params.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L30"},"initialIsOpen":false},{"id":"def-server.OptionedValueProp","type":"Interface","label":"OptionedValueProp","description":[],"children":[{"id":"def-server.OptionedValueProp.value","type":"string","label":"value","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/optioned.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L13"}},{"id":"def-server.OptionedValueProp.text","type":"string","label":"text","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/optioned.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L14"}},{"id":"def-server.OptionedValueProp.disabled","type":"CompoundType","label":"disabled","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/optioned.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L15"},"signature":["boolean | undefined"]},{"id":"def-server.OptionedValueProp.isCompatible","type":"Function","label":"isCompatible","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/optioned.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L16"},"signature":["(agg: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},") => boolean"]}],"source":{"path":"src/plugins/data/common/search/aggs/param_types/optioned.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L12"},"initialIsOpen":false},{"id":"def-server.ISearchOptions","type":"Interface","label":"ISearchOptions","description":[],"children":[{"id":"def-server.ISearchOptions.abortSignal","type":"Object","label":"abortSignal","description":["\nAn `AbortSignal` that allows the caller of `search` to abort a search request."],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":87,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L87"},"signature":["AbortSignal | undefined"]},{"id":"def-server.ISearchOptions.strategy","type":"string","label":"strategy","description":["\nUse this option to force using a specific server side search strategy. Leave empty to use the default strategy."],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L92"},"signature":["string | undefined"]},{"id":"def-server.ISearchOptions.legacyHitsTotal","type":"CompoundType","label":"legacyHitsTotal","description":["\nRequest the legacy format for the total number of hits. If sending `rest_total_hits_as_int` to\nsomething other than `true`, this should be set to `false`."],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L98"},"signature":["boolean | undefined"]},{"id":"def-server.ISearchOptions.sessionId","type":"string","label":"sessionId","description":["\nA session ID, grouping multiple search requests into a single session."],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L103"},"signature":["string | undefined"]},{"id":"def-server.ISearchOptions.isStored","type":"CompoundType","label":"isStored","description":["\nWhether the session is already saved (i.e. sent to background)"],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L108"},"signature":["boolean | undefined"]},{"id":"def-server.ISearchOptions.isRestore","type":"CompoundType","label":"isRestore","description":["\nWhether the session is restored (i.e. search requests should re-use the stored search IDs,\nrather than starting from scratch)"],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":114,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L114"},"signature":["boolean | undefined"]},{"id":"def-server.ISearchOptions.indexPattern","type":"Object","label":"indexPattern","description":["\nIndex pattern reference is used for better error messages"],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":120,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L120"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}," | undefined"]}],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L83"},"initialIsOpen":false},{"id":"def-server.IEsSearchRequest","type":"Interface","label":"IEsSearchRequest","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IEsSearchRequest","text":"IEsSearchRequest"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IKibanaSearchRequest","text":"IKibanaSearchRequest"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchRequestParams","text":"ISearchRequestParams"},">>"],"description":[],"children":[{"id":"def-server.IEsSearchRequest.indexType","type":"string","label":"indexType","description":[],"source":{"path":"src/plugins/data/common/search/es_search/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/es_search/types.ts#L20"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/data/common/search/es_search/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/es_search/types.ts#L19"},"initialIsOpen":false},{"id":"def-server.RefreshInterval","type":"Interface","label":"RefreshInterval","description":[],"children":[{"id":"def-server.RefreshInterval.pause","type":"boolean","label":"pause","description":[],"source":{"path":"src/plugins/data/common/query/timefilter/types.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L12"}},{"id":"def-server.RefreshInterval.value","type":"number","label":"value","description":[],"source":{"path":"src/plugins/data/common/query/timefilter/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L13"}}],"source":{"path":"src/plugins/data/common/query/timefilter/types.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L11"},"initialIsOpen":false}],"enums":[{"id":"def-server.ES_FIELD_TYPES","type":"Enum","label":"ES_FIELD_TYPES","description":[],"source":{"path":"src/plugins/data/common/kbn_field_types/types.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/types.ts#L18"},"initialIsOpen":false},{"id":"def-server.KBN_FIELD_TYPES","type":"Enum","label":"KBN_FIELD_TYPES","description":[],"source":{"path":"src/plugins/data/common/kbn_field_types/types.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/types.ts#L57"},"initialIsOpen":false},{"id":"def-server.BUCKET_TYPES","type":"Enum","label":"BUCKET_TYPES","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/bucket_agg_types.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/bucket_agg_types.ts#L9"},"initialIsOpen":false},{"id":"def-server.METRIC_TYPES","type":"Enum","label":"METRIC_TYPES","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/metric_agg_types.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_types.ts#L9"},"initialIsOpen":false}],"misc":[{"id":"def-server.IFieldFormatsRegistry","type":"Type","label":"IFieldFormatsRegistry","description":[],"source":{"path":"src/plugins/data/common/field_formats/index.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/index.ts#L11"},"signature":["{ init: (getConfig: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.GetConfigFn","text":"GetConfigFn"},", metaParamsOptions?: Record, defaultFieldConverters?: ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatInstanceType","text":"FieldFormatInstanceType"},"[]) => void; register: (fieldFormats: ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatInstanceType","text":"FieldFormatInstanceType"},"[]) => void; deserialize: ","FormatFactory","; getDefaultConfig: (fieldType: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"}],"initialIsOpen":false},{"id":"def-server.FieldFormatsGetConfigFn","type":"Type","label":"FieldFormatsGetConfigFn","description":[],"source":{"path":"src/plugins/data/common/field_formats/types.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L67"},"signature":["(key: string, defaultOverride: T | undefined) => T"],"initialIsOpen":false},{"id":"def-server.IndexPatternLoadExpressionFunctionDefinition","type":"Type","label":"IndexPatternLoadExpressionFunctionDefinition","description":[],"source":{"path":"src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/expressions/load_index_pattern.ts#L34"},"signature":["ExpressionFunctionDefinition<\"indexPatternLoad\", null, Arguments, Output, ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},"<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},">>"],"initialIsOpen":false},{"id":"def-server.AggGroupName","type":"Type","label":"AggGroupName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_groups.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L18"},"signature":["\"buckets\" | \"metrics\" | \"none\""],"initialIsOpen":false},{"id":"def-server.AggParam","type":"Type","label":"AggParam","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_params.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L28"},"signature":["BaseParamType"],"initialIsOpen":false},{"id":"def-server.AggConfigOptions","type":"Type","label":"AggConfigOptions","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L43"},"signature":["{ type: IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | SerializableState | undefined; }"],"initialIsOpen":false},{"id":"def-server.EsaggsExpressionFunctionDefinition","type":"Type","label":"EsaggsExpressionFunctionDefinition","description":[],"source":{"path":"src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#L35"},"signature":["ExpressionFunctionDefinition<\"esaggs\", Input, Arguments, Output, ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},"<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},">>"],"initialIsOpen":false},{"id":"def-server.IAggConfig","type":"Type","label":"IAggConfig","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L53"},"signature":["AggConfig"],"initialIsOpen":false},{"id":"def-server.IAggConfigs","type":"Type","label":"IAggConfigs","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L55"},"signature":["AggConfigs"],"initialIsOpen":false},{"id":"def-server.IAggType","type":"Type","label":"IAggType","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L58"},"signature":["AggType>"],"initialIsOpen":false},{"id":"def-server.IFieldParamType","type":"Type","label":"IFieldParamType","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/field.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/field.ts#L21"},"signature":["FieldParamType"],"initialIsOpen":false},{"id":"def-server.IMetricAggType","type":"Type","label":"IMetricAggType","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L35"},"signature":["MetricAggType"],"initialIsOpen":false},{"id":"def-server.ParsedInterval","type":"Type","label":"ParsedInterval","description":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts#L18"},"signature":["{ value: number; unit: Unit; type: \"calendar\" | \"fixed\"; }"],"initialIsOpen":false},{"id":"def-server.ExecutionContextSearch","type":"Type","label":"ExecutionContextSearch","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context_type.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L14"},"signature":["{ filters?: Filter[] | undefined; query?: Query | Query[] | undefined; timeRange?: TimeRange | undefined; }"],"initialIsOpen":false},{"id":"def-server.ExpressionFunctionKibana","type":"Type","label":"ExpressionFunctionKibana","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana.ts#L17"},"signature":["ExpressionFunctionDefinition<\"kibana\", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"kibana_context\", ExecutionContextSearch> | null, object, ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"kibana_context\", ExecutionContextSearch>, ExecutionContext>"],"initialIsOpen":false},{"id":"def-server.ExpressionFunctionKibanaContext","type":"Type","label":"ExpressionFunctionKibanaContext","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L23"},"signature":["ExpressionFunctionDefinition<\"kibana_context\", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"kibana_context\", ExecutionContextSearch> | null, Arguments, Promise<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"kibana_context\", ExecutionContextSearch>>, ExecutionContext>"],"initialIsOpen":false},{"id":"def-server.ExpressionValueSearchContext","type":"Type","label":"ExpressionValueSearchContext","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context_type.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L20"},"signature":["{ type: \"kibana_context\"; } & ExecutionContextSearch"],"initialIsOpen":false},{"id":"def-server.KibanaContext","type":"Type","label":"KibanaContext","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context_type.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L27"},"signature":["{ type: \"kibana_context\"; } & ExecutionContextSearch"],"initialIsOpen":false},{"id":"def-server.IEsSearchResponse","type":"Type","label":"IEsSearchResponse","description":[],"source":{"path":"src/plugins/data/common/search/es_search/types.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/es_search/types.ts#L23"},"signature":["IKibanaSearchResponse>"],"initialIsOpen":false},{"id":"def-server.ES_SEARCH_STRATEGY","type":"string","label":"ES_SEARCH_STRATEGY","description":[],"source":{"path":"src/plugins/data/common/search/es_search/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/es_search/types.ts#L13"},"signature":["\"es\""],"initialIsOpen":false},{"id":"def-server.Filter","type":"Type","label":"Filter","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L41"},"signature":["{ $state?: FilterState | undefined; meta: FilterMeta; query?: any; }"],"initialIsOpen":false},{"id":"def-server.Query","type":"Type","label":"Query","description":[],"source":{"path":"src/plugins/data/common/query/types.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/types.ts#L12"},"signature":["{ query: string | { [key: string]: any; }; language: string; }"],"initialIsOpen":false},{"id":"def-server.TimeRange","type":"Type","label":"TimeRange","description":[],"source":{"path":"src/plugins/data/common/query/timefilter/types.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L17"},"signature":["{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }"],"initialIsOpen":false}],"objects":[{"id":"def-server.esFilters","type":"Object","children":[{"id":"def-server.esFilters.buildQueryFilter","type":"Function","label":"buildQueryFilter","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L30"},"signature":["(query: any, index: string, alias: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.QueryStringFilter","text":"QueryStringFilter"}]},{"id":"def-server.esFilters.buildCustomFilter","type":"Function","label":"buildCustomFilter","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L31"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.buildCustomFilter","text":"buildCustomFilter"}]},{"id":"def-server.esFilters.buildEmptyFilter","type":"Function","label":"buildEmptyFilter","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L32"},"signature":["(isPinned: boolean, index?: string | undefined) => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}]},{"id":"def-server.esFilters.buildExistsFilter","type":"Function","label":"buildExistsFilter","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L33"},"signature":["(field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"},", indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ExistsFilter","text":"ExistsFilter"}]},{"id":"def-server.esFilters.buildFilter","type":"Function","label":"buildFilter","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L34"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.buildFilter","text":"buildFilter"}]},{"id":"def-server.esFilters.buildPhraseFilter","type":"Function","label":"buildPhraseFilter","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L35"},"signature":["(field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"},", value: any, indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.PhraseFilter","text":"PhraseFilter"}]},{"id":"def-server.esFilters.buildPhrasesFilter","type":"Function","label":"buildPhrasesFilter","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L36"},"signature":["(field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"},", params: any[], indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.PhrasesFilter","text":"PhrasesFilter"}]},{"id":"def-server.esFilters.buildRangeFilter","type":"Function","label":"buildRangeFilter","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L37"},"signature":["(field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"},", params: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.RangeFilterParams","text":"RangeFilterParams"},", indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"},", formattedValue?: string | undefined) => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.RangeFilter","text":"RangeFilter"}]},{"id":"def-server.esFilters.isFilterDisabled","type":"Function","label":"isFilterDisabled","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L38"},"signature":["(filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},") => boolean"]}],"description":[],"label":"esFilters","source":{"path":"src/plugins/data/server/index.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L29"},"initialIsOpen":false},{"id":"def-server.exporters","type":"Object","children":[{"id":"def-server.exporters.datatableToCSV","type":"Function","label":"datatableToCSV","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L47"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.datatableToCSV","text":"datatableToCSV"}]},{"id":"def-server.exporters.CSV_MIME_TYPE","type":"string","label":"CSV_MIME_TYPE","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L48"}}],"description":[],"label":"exporters","source":{"path":"src/plugins/data/server/index.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L46"},"initialIsOpen":false},{"id":"def-server.esKuery","type":"Object","children":[{"id":"def-server.esKuery.nodeTypes","type":"Object","label":"nodeTypes","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L65"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.NodeTypes","text":"NodeTypes"}]},{"id":"def-server.esKuery.fromKueryExpression","type":"Function","label":"fromKueryExpression","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L66"},"signature":["(expression: any, parseOptions?: Partial<",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KueryParseOptions","text":"KueryParseOptions"},">) => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KueryNode","text":"KueryNode"}]},{"id":"def-server.esKuery.toElasticsearchQuery","type":"Function","label":"toElasticsearchQuery","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L67"},"signature":["(node: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KueryNode","text":"KueryNode"},", indexPattern?: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"}," | undefined, config?: Record | undefined, context?: Record | undefined) => ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.JsonObject","text":"JsonObject"}]}],"description":[],"label":"esKuery","source":{"path":"src/plugins/data/server/index.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L64"},"initialIsOpen":false},{"id":"def-server.esQuery","type":"Object","children":[{"id":"def-server.esQuery.buildQueryFromFilters","type":"Function","label":"buildQueryFromFilters","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L71"},"signature":["(filters: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[] | undefined, indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"}," | undefined, ignoreFilterIfFieldNotInIndex?: boolean) => { must: never[]; filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]; should: never[]; must_not: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]; }"]},{"id":"def-server.esQuery.getEsQueryConfig","type":"Function","label":"getEsQueryConfig","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L72"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.getEsQueryConfig","text":"getEsQueryConfig"}]},{"id":"def-server.esQuery.buildEsQuery","type":"Function","label":"buildEsQuery","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L73"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.buildEsQuery","text":"buildEsQuery"}]}],"description":[],"label":"esQuery","source":{"path":"src/plugins/data/server/index.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L70"},"initialIsOpen":false},{"id":"def-server.fieldFormats","type":"Object","children":[{"id":"def-server.fieldFormats.FieldFormatsRegistry","type":"Object","label":"FieldFormatsRegistry","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L101"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatsRegistry","text":"FieldFormatsRegistry"}]},{"id":"def-server.fieldFormats.FieldFormat","type":"Object","label":"FieldFormat","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L102"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"}]},{"id":"def-server.fieldFormats.BoolFormat","type":"Object","label":"BoolFormat","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L103"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.BoolFormat","text":"BoolFormat"}]},{"id":"def-server.fieldFormats.BytesFormat","type":"Object","label":"BytesFormat","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L104"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.BytesFormat","text":"BytesFormat"}]},{"id":"def-server.fieldFormats.ColorFormat","type":"Object","label":"ColorFormat","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":105,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L105"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.ColorFormat","text":"ColorFormat"}]},{"id":"def-server.fieldFormats.DurationFormat","type":"Object","label":"DurationFormat","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":106,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L106"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.DurationFormat","text":"DurationFormat"}]},{"id":"def-server.fieldFormats.IpFormat","type":"Object","label":"IpFormat","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":107,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L107"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.IpFormat","text":"IpFormat"}]},{"id":"def-server.fieldFormats.NumberFormat","type":"Object","label":"NumberFormat","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L108"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.NumberFormat","text":"NumberFormat"}]},{"id":"def-server.fieldFormats.PercentFormat","type":"Object","label":"PercentFormat","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":109,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L109"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.PercentFormat","text":"PercentFormat"}]},{"id":"def-server.fieldFormats.RelativeDateFormat","type":"Object","label":"RelativeDateFormat","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L110"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.RelativeDateFormat","text":"RelativeDateFormat"}]},{"id":"def-server.fieldFormats.SourceFormat","type":"Object","label":"SourceFormat","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":111,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L111"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.SourceFormat","text":"SourceFormat"}]},{"id":"def-server.fieldFormats.StaticLookupFormat","type":"Object","label":"StaticLookupFormat","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":112,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L112"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.StaticLookupFormat","text":"StaticLookupFormat"}]},{"id":"def-server.fieldFormats.UrlFormat","type":"Object","label":"UrlFormat","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":113,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L113"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.UrlFormat","text":"UrlFormat"}]},{"id":"def-server.fieldFormats.StringFormat","type":"Object","label":"StringFormat","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":114,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L114"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.StringFormat","text":"StringFormat"}]},{"id":"def-server.fieldFormats.TruncateFormat","type":"Object","label":"TruncateFormat","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L115"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.TruncateFormat","text":"TruncateFormat"}]}],"description":[],"label":"fieldFormats","source":{"path":"src/plugins/data/server/index.ts","lineNumber":100,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L100"},"initialIsOpen":false},{"id":"def-server.indexPatterns","type":"Object","children":[{"id":"def-server.indexPatterns.isFilterable","type":"Function","label":"isFilterable","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":127,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L127"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.isFilterable","text":"isFilterable"}]},{"id":"def-server.indexPatterns.isNestedField","type":"Function","label":"isNestedField","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":128,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L128"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.isNestedField","text":"isNestedField"}]}],"description":[],"label":"indexPatterns","source":{"path":"src/plugins/data/server/index.ts","lineNumber":126,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L126"},"initialIsOpen":false},{"id":"def-server.UI_SETTINGS","type":"Object","label":"UI_SETTINGS","description":[],"source":{"path":"src/plugins/data/common/constants.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/constants.ts#L11"},"signature":["{ readonly META_FIELDS: \"metaFields\"; readonly DOC_HIGHLIGHT: \"doc_table:highlight\"; readonly QUERY_STRING_OPTIONS: \"query:queryString:options\"; readonly QUERY_ALLOW_LEADING_WILDCARDS: \"query:allowLeadingWildcards\"; readonly SEARCH_QUERY_LANGUAGE: \"search:queryLanguage\"; readonly SORT_OPTIONS: \"sort:options\"; readonly COURIER_IGNORE_FILTER_IF_FIELD_NOT_IN_INDEX: \"courier:ignoreFilterIfFieldNotInIndex\"; readonly COURIER_SET_REQUEST_PREFERENCE: \"courier:setRequestPreference\"; readonly COURIER_CUSTOM_REQUEST_PREFERENCE: \"courier:customRequestPreference\"; readonly COURIER_MAX_CONCURRENT_SHARD_REQUESTS: \"courier:maxConcurrentShardRequests\"; readonly COURIER_BATCH_SEARCHES: \"courier:batchSearches\"; readonly SEARCH_INCLUDE_FROZEN: \"search:includeFrozen\"; readonly SEARCH_TIMEOUT: \"search:timeout\"; readonly HISTOGRAM_BAR_TARGET: \"histogram:barTarget\"; readonly HISTOGRAM_MAX_BARS: \"histogram:maxBars\"; readonly HISTORY_LIMIT: \"history:limit\"; readonly SHORT_DOTS_ENABLE: \"shortDots:enable\"; readonly FORMAT_DEFAULT_TYPE_MAP: \"format:defaultTypeMap\"; readonly FORMAT_NUMBER_DEFAULT_PATTERN: \"format:number:defaultPattern\"; readonly FORMAT_PERCENT_DEFAULT_PATTERN: \"format:percent:defaultPattern\"; readonly FORMAT_BYTES_DEFAULT_PATTERN: \"format:bytes:defaultPattern\"; readonly FORMAT_CURRENCY_DEFAULT_PATTERN: \"format:currency:defaultPattern\"; readonly FORMAT_NUMBER_DEFAULT_LOCALE: \"format:number:defaultLocale\"; readonly TIMEPICKER_REFRESH_INTERVAL_DEFAULTS: \"timepicker:refreshIntervalDefaults\"; readonly TIMEPICKER_QUICK_RANGES: \"timepicker:quickRanges\"; readonly TIMEPICKER_TIME_DEFAULTS: \"timepicker:timeDefaults\"; readonly INDEXPATTERN_PLACEHOLDER: \"indexPattern:placeholder\"; readonly FILTERS_PINNED_BY_DEFAULT: \"filters:pinnedByDefault\"; readonly FILTERS_EDITOR_SUGGEST_VALUES: \"filterEditor:suggestValues\"; readonly AUTOCOMPLETE_USE_TIMERANGE: \"autocomplete:useTimeRange\"; }"],"initialIsOpen":false},{"id":"def-server.AggGroupLabels","type":"Object","children":[{"id":"def-server.AggGroupLabels.[AggGroupNames.Buckets]","type":"string","label":"[AggGroupNames.Buckets]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_groups.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L21"}},{"id":"def-server.AggGroupLabels.[AggGroupNames.Metrics]","type":"string","label":"[AggGroupNames.Metrics]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_groups.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L24"}},{"id":"def-server.AggGroupLabels.[AggGroupNames.None]","type":"string","label":"[AggGroupNames.None]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_groups.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L27"}}],"description":[],"label":"AggGroupLabels","source":{"path":"src/plugins/data/common/search/aggs/agg_groups.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L20"},"initialIsOpen":false},{"id":"def-server.AggGroupNames","type":"Object","label":"AggGroupNames","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_groups.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L12"},"signature":["Readonly<{ Buckets: \"buckets\"; Metrics: \"metrics\"; None: \"none\"; }>"],"initialIsOpen":false},{"id":"def-server.search","type":"Object","children":[{"id":"def-server.search.aggs","type":"Object","children":[{"id":"def-server.search.aggs.CidrMask","type":"Object","label":"CidrMask","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":243,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L243"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.CidrMask","text":"CidrMask"}]},{"id":"def-server.search.aggs.dateHistogramInterval","type":"Function","label":"dateHistogramInterval","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":244,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L244"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.dateHistogramInterval","text":"dateHistogramInterval"}]},{"id":"def-server.search.aggs.intervalOptions","type":"Array","label":"intervalOptions","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":245,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L245"},"signature":["({ display: string; val: string; enabled(agg: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IBucketAggConfig","text":"IBucketAggConfig"},"): boolean | \"\" | undefined; } | { display: string; val: string; })[]"]},{"id":"def-server.search.aggs.InvalidEsCalendarIntervalError","type":"Object","label":"InvalidEsCalendarIntervalError","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":246,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L246"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.InvalidEsCalendarIntervalError","text":"InvalidEsCalendarIntervalError"}]},{"id":"def-server.search.aggs.InvalidEsIntervalFormatError","type":"Object","label":"InvalidEsIntervalFormatError","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":247,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L247"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.InvalidEsIntervalFormatError","text":"InvalidEsIntervalFormatError"}]},{"id":"def-server.search.aggs.Ipv4Address","type":"Object","label":"Ipv4Address","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":248,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L248"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.Ipv4Address","text":"Ipv4Address"}]},{"id":"def-server.search.aggs.isNumberType","type":"Function","label":"isNumberType","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":249,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L249"},"signature":["(agg: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},") => boolean"]},{"id":"def-server.search.aggs.isStringType","type":"Function","label":"isStringType","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":250,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L250"},"signature":["(agg: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},") => boolean"]},{"id":"def-server.search.aggs.isType","type":"Function","label":"isType","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":251,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L251"},"signature":["(...types: string[]) => (agg: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},") => boolean"]},{"id":"def-server.search.aggs.isValidEsInterval","type":"Function","label":"isValidEsInterval","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":252,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L252"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.isValidEsInterval","text":"isValidEsInterval"}]},{"id":"def-server.search.aggs.isValidInterval","type":"Function","label":"isValidInterval","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":253,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L253"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.isValidInterval","text":"isValidInterval"}]},{"id":"def-server.search.aggs.parentPipelineType","type":"string","label":"parentPipelineType","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":254,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L254"}},{"id":"def-server.search.aggs.parseEsInterval","type":"Function","label":"parseEsInterval","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":255,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L255"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.parseEsInterval","text":"parseEsInterval"}]},{"id":"def-server.search.aggs.parseInterval","type":"Function","label":"parseInterval","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":256,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L256"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.parseInterval","text":"parseInterval"}]},{"id":"def-server.search.aggs.propFilter","type":"Function","label":"propFilter","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":257,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L257"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.propFilter","text":"propFilter"}]},{"id":"def-server.search.aggs.siblingPipelineType","type":"string","label":"siblingPipelineType","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":258,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L258"}},{"id":"def-server.search.aggs.termsAggFilter","type":"Array","label":"termsAggFilter","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":259,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L259"},"signature":["string[]"]},{"id":"def-server.search.aggs.toAbsoluteDates","type":"Function","label":"toAbsoluteDates","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":260,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L260"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.toAbsoluteDates","text":"toAbsoluteDates"}]},{"id":"def-server.search.aggs.calcAutoIntervalLessThan","type":"Function","label":"calcAutoIntervalLessThan","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":261,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L261"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.calcAutoIntervalLessThan","text":"calcAutoIntervalLessThan"}]}],"description":[],"label":"aggs","source":{"path":"src/plugins/data/server/index.ts","lineNumber":242,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L242"}},{"id":"def-server.search.getRequestInspectorStats","type":"Function","label":"getRequestInspectorStats","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":263,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L263"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.getRequestInspectorStats","text":"getRequestInspectorStats"}]},{"id":"def-server.search.getResponseInspectorStats","type":"Function","label":"getResponseInspectorStats","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":264,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L264"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.getResponseInspectorStats","text":"getResponseInspectorStats"}]},{"id":"def-server.search.tabifyAggResponse","type":"Function","label":"tabifyAggResponse","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":265,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L265"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.tabifyAggResponse","text":"tabifyAggResponse"}]},{"id":"def-server.search.tabifyGetColumns","type":"Function","label":"tabifyGetColumns","description":[],"source":{"path":"src/plugins/data/server/index.ts","lineNumber":266,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L266"},"signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.tabifyGetColumns","text":"tabifyGetColumns"}]}],"description":[],"label":"search","source":{"path":"src/plugins/data/server/index.ts","lineNumber":241,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index.ts#L241"},"initialIsOpen":false}],"setup":{"id":"def-server.DataPluginSetup","type":"Interface","label":"DataPluginSetup","description":[],"children":[{"id":"def-server.DataPluginSetup.search","type":"Object","label":"search","description":[],"source":{"path":"src/plugins/data/server/plugin.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L29"},"signature":[{"pluginId":"data","scope":"server","docId":"kibDataSearchPluginApi","section":"def-server.ISearchSetup","text":"ISearchSetup"}]},{"id":"def-server.DataPluginSetup.fieldFormats","type":"Object","label":"fieldFormats","description":[],"source":{"path":"src/plugins/data/server/plugin.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L30"},"signature":["{ register: (customFieldFormat: ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatInstanceType","text":"FieldFormatInstanceType"},") => number; }"]},{"id":"def-server.DataPluginSetup.__enhance","type":"Function","label":"__enhance","description":[],"source":{"path":"src/plugins/data/server/plugin.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L34"},"signature":["(enhancements: ",{"pluginId":"data","scope":"server","docId":"kibDataPluginApi","section":"def-server.DataEnhancements","text":"DataEnhancements"},") => void"]}],"source":{"path":"src/plugins/data/server/plugin.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L28"},"lifecycle":"setup","initialIsOpen":true},"start":{"id":"def-server.DataPluginStart","type":"Interface","label":"DataPluginStart","description":[],"children":[{"id":"def-server.DataPluginStart.search","type":"Object","label":"search","description":[],"source":{"path":"src/plugins/data/server/plugin.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L38"},"signature":[{"pluginId":"data","scope":"server","docId":"kibDataSearchPluginApi","section":"def-server.ISearchStart","text":"ISearchStart"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IEsSearchRequest","text":"IEsSearchRequest"},", ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IEsSearchResponse","text":"IEsSearchResponse"},">"]},{"id":"def-server.DataPluginStart.fieldFormats","type":"Object","label":"fieldFormats","description":[],"source":{"path":"src/plugins/data/server/plugin.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L39"},"signature":["{ fieldFormatServiceFactory: (uiSettings: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.IUiSettingsClient","text":"IUiSettingsClient"},") => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatsRegistry","text":"FieldFormatsRegistry"},">; }"]},{"id":"def-server.DataPluginStart.indexPatterns","type":"Object","label":"indexPatterns","description":[],"source":{"path":"src/plugins/data/server/plugin.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L40"},"signature":[{"pluginId":"data","scope":"server","docId":"kibDataIndexPatternsPluginApi","section":"def-server.IndexPatternsServiceStart","text":"IndexPatternsServiceStart"}]}],"source":{"path":"src/plugins/data/server/plugin.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/plugin.ts#L37"},"lifecycle":"start","initialIsOpen":true}},"common":{"classes":[{"id":"def-common.KQLSyntaxError","type":"Class","label":"KQLSyntaxError","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KQLSyntaxError","text":"KQLSyntaxError"}," extends Error"],"children":[{"id":"def-common.KQLSyntaxError.shortMessage","type":"string","label":"shortMessage","description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/kuery_syntax_error.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/kuery_syntax_error.ts#L42"}},{"id":"def-common.KQLSyntaxError.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"error","isRequired":true,"signature":["KQLSyntaxErrorData"],"description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/kuery_syntax_error.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/kuery_syntax_error.ts#L44"}},{"type":"Any","label":"expression","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/kuery_syntax_error.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/kuery_syntax_error.ts#L44"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/es_query/kuery/kuery_syntax_error.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/kuery_syntax_error.ts#L44"}}],"source":{"path":"src/plugins/data/common/es_query/kuery/kuery_syntax_error.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/kuery_syntax_error.ts#L41"},"initialIsOpen":false},{"id":"def-common.KbnFieldType","type":"Class","label":"KbnFieldType","description":[],"children":[{"id":"def-common.KbnFieldType.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/data/common/kbn_field_types/kbn_field_type.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_type.ts#L12"}},{"id":"def-common.KbnFieldType.sortable","type":"boolean","label":"sortable","description":[],"source":{"path":"src/plugins/data/common/kbn_field_types/kbn_field_type.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_type.ts#L13"}},{"id":"def-common.KbnFieldType.filterable","type":"boolean","label":"filterable","description":[],"source":{"path":"src/plugins/data/common/kbn_field_types/kbn_field_type.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_type.ts#L14"}},{"id":"def-common.KbnFieldType.esTypes","type":"Object","label":"esTypes","description":[],"source":{"path":"src/plugins/data/common/kbn_field_types/kbn_field_type.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_type.ts#L15"},"signature":["readonly ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ES_FIELD_TYPES","text":"ES_FIELD_TYPES"},"[]"]},{"id":"def-common.KbnFieldType.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"options","isRequired":true,"signature":["Partial<",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KbnFieldTypeOptions","text":"KbnFieldTypeOptions"},">"],"description":[],"source":{"path":"src/plugins/data/common/kbn_field_types/kbn_field_type.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_type.ts#L17"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/kbn_field_types/kbn_field_type.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_type.ts#L17"}}],"source":{"path":"src/plugins/data/common/kbn_field_types/kbn_field_type.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_type.ts#L11"},"initialIsOpen":false}],"functions":[{"id":"def-common.buildEsQuery","type":"Function","label":"buildEsQuery","signature":["(indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"}," | undefined, queries: ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.Query","text":"Query"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.Query","text":"Query"},"[], filters: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}],"description":[],"children":[{"type":"Object","label":"indexPattern","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/es_query/es_query/build_es_query.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L33"}},{"type":"CompoundType","label":"queries","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.Query","text":"Query"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.Query","text":"Query"},"[]"],"description":["- a query object or array of query objects. Each query has a language property and a query property."],"source":{"path":"src/plugins/data/common/es_query/es_query/build_es_query.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L34"}},{"type":"CompoundType","label":"filters","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]"],"description":["- a filter object or array of filter objects"],"source":{"path":"src/plugins/data/common/es_query/es_query/build_es_query.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L35"}},{"type":"Object","label":"config","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.EsQueryConfig","text":"EsQueryConfig"}],"description":["- an objects with query:allowLeadingWildcards and query:queryString:options UI\nsettings in form of { allowLeadingWildcards, queryStringOptions }\nconfig contains dateformat:tz"],"source":{"path":"src/plugins/data/common/es_query/es_query/build_es_query.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L36"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/es_query/es_query/build_es_query.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L32"},"initialIsOpen":false},{"id":"def-common.buildQueryFromFilters","type":"Function","children":[{"type":"Array","label":"filters","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]"],"description":[],"source":{"path":"src/plugins/data/common/es_query/es_query/from_filters.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/from_filters.ts#L47"}},{"type":"Object","label":"indexPattern","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/es_query/es_query/from_filters.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/from_filters.ts#L48"}},{"type":"boolean","label":"ignoreFilterIfFieldNotInIndex","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/es_query/es_query/from_filters.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/from_filters.ts#L49"}}],"signature":["(filters: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[] | undefined, indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"}," | undefined, ignoreFilterIfFieldNotInIndex?: boolean) => { must: never[]; filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]; should: never[]; must_not: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]; }"],"description":[],"label":"buildQueryFromFilters","source":{"path":"src/plugins/data/common/es_query/es_query/from_filters.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/from_filters.ts#L46"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.luceneStringToDsl","type":"Function","label":"luceneStringToDsl","signature":["(query: any) => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.DslQuery","text":"DslQuery"}],"description":[],"children":[{"type":"Any","label":"query","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/es_query/es_query/lucene_string_to_dsl.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/lucene_string_to_dsl.ts#L12"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/es_query/es_query/lucene_string_to_dsl.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/lucene_string_to_dsl.ts#L12"},"initialIsOpen":false},{"id":"def-common.decorateQuery","type":"Function","label":"decorateQuery","signature":["(query: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.DslQuery","text":"DslQuery"},", queryStringOptions: string | Record, dateFormatTZ: string | undefined) => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.DslQuery","text":"DslQuery"}],"description":["\nDecorate queries with default parameters"],"children":[{"type":"CompoundType","label":"query","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.DslQuery","text":"DslQuery"}],"description":["object"],"source":{"path":"src/plugins/data/common/es_query/es_query/decorate_query.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/decorate_query.ts#L22"}},{"type":"CompoundType","label":"queryStringOptions","isRequired":true,"signature":["string | Record"],"description":["query:queryString:options from UI settings"],"source":{"path":"src/plugins/data/common/es_query/es_query/decorate_query.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/decorate_query.ts#L23"}},{"type":"string","label":"dateFormatTZ","isRequired":false,"signature":["string | undefined"],"description":["dateFormat:tz from UI settings"],"source":{"path":"src/plugins/data/common/es_query/es_query/decorate_query.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/decorate_query.ts#L24"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/es_query/es_query/decorate_query.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/decorate_query.ts#L21"},"initialIsOpen":false},{"id":"def-common.getEsQueryConfig","type":"Function","label":"getEsQueryConfig","signature":["(config: KibanaConfig) => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.EsQueryConfig","text":"EsQueryConfig"}],"description":[],"children":[{"type":"Object","label":"config","isRequired":true,"signature":["KibanaConfig"],"description":[],"source":{"path":"src/plugins/data/common/es_query/es_query/get_es_query_config.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/get_es_query_config.ts#L16"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/es_query/es_query/get_es_query_config.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/get_es_query_config.ts#L16"},"initialIsOpen":false},{"id":"def-common.cleanFilter","type":"Function","children":[{"type":"Object","label":"filter","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/index.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/index.ts#L36"}}],"signature":["(filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}],"description":["\nClean out any invalid attributes from the filters"],"label":"cleanFilter","source":{"path":"src/plugins/data/common/es_query/filters/index.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/index.ts#L36"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.isFilterDisabled","type":"Function","children":[{"type":"Object","label":"filter","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/index.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/index.ts#L38"}}],"signature":["(filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},") => boolean"],"description":[],"label":"isFilterDisabled","source":{"path":"src/plugins/data/common/es_query/filters/index.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/index.ts#L38"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.buildFilter","type":"Function","label":"buildFilter","signature":["(indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"},", field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"},", type: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.FILTERS","text":"FILTERS"},", negate: boolean, disabled: boolean, params: any, alias: string | null, store: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.FilterStateStore","text":"FilterStateStore"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}],"description":[],"children":[{"type":"Object","label":"indexPattern","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/build_filters.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L22"}},{"type":"Object","label":"field","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/build_filters.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L23"}},{"type":"Enum","label":"type","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.FILTERS","text":"FILTERS"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/build_filters.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L24"}},{"type":"boolean","label":"negate","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/build_filters.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L25"}},{"type":"boolean","label":"disabled","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/build_filters.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L26"}},{"type":"Any","label":"params","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/build_filters.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L27"}},{"type":"CompoundType","label":"alias","isRequired":false,"signature":["string | null"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/build_filters.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L28"}},{"type":"Enum","label":"store","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.FilterStateStore","text":"FilterStateStore"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/build_filters.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L29"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/es_query/filters/build_filters.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L21"},"initialIsOpen":false},{"id":"def-common.buildCustomFilter","type":"Function","label":"buildCustomFilter","signature":["(indexPatternString: string, queryDsl: any, disabled: boolean, negate: boolean, alias: string | null, store: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.FilterStateStore","text":"FilterStateStore"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}],"description":[],"children":[{"type":"string","label":"indexPatternString","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/build_filters.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L40"}},{"type":"Any","label":"queryDsl","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/build_filters.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L41"}},{"type":"boolean","label":"disabled","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/build_filters.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L42"}},{"type":"boolean","label":"negate","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/build_filters.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L43"}},{"type":"CompoundType","label":"alias","isRequired":false,"signature":["string | null"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/build_filters.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L44"}},{"type":"Enum","label":"store","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.FilterStateStore","text":"FilterStateStore"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/build_filters.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L45"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/es_query/filters/build_filters.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/build_filters.ts#L39"},"initialIsOpen":false},{"id":"def-common.isExistsFilter","type":"Function","children":[{"type":"Any","label":"filter","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/exists_filter.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/exists_filter.ts#L23"}}],"signature":["(filter: any) => filter is ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ExistsFilter","text":"ExistsFilter"}],"description":[],"label":"isExistsFilter","source":{"path":"src/plugins/data/common/es_query/filters/exists_filter.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/exists_filter.ts#L23"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getExistsFilterField","type":"Function","children":[{"type":"CompoundType","label":"filter","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ExistsFilter","text":"ExistsFilter"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/exists_filter.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/exists_filter.ts#L25"}}],"signature":["(filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ExistsFilter","text":"ExistsFilter"},") => any"],"description":[],"label":"getExistsFilterField","source":{"path":"src/plugins/data/common/es_query/filters/exists_filter.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/exists_filter.ts#L25"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.buildExistsFilter","type":"Function","children":[{"type":"Object","label":"field","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/exists_filter.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/exists_filter.ts#L29"}},{"type":"Object","label":"indexPattern","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/exists_filter.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/exists_filter.ts#L29"}}],"signature":["(field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"},", indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ExistsFilter","text":"ExistsFilter"}],"description":[],"label":"buildExistsFilter","source":{"path":"src/plugins/data/common/es_query/filters/exists_filter.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/exists_filter.ts#L29"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.isGeoBoundingBoxFilter","type":"Function","children":[{"type":"Any","label":"filter","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts#L23"}}],"signature":["(filter: any) => filter is ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.GeoBoundingBoxFilter","text":"GeoBoundingBoxFilter"}],"description":[],"label":"isGeoBoundingBoxFilter","source":{"path":"src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts#L23"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getGeoBoundingBoxFilterField","type":"Function","children":[{"type":"CompoundType","label":"filter","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.GeoBoundingBoxFilter","text":"GeoBoundingBoxFilter"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts#L26"}}],"signature":["(filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.GeoBoundingBoxFilter","text":"GeoBoundingBoxFilter"},") => any"],"description":[],"label":"getGeoBoundingBoxFilterField","source":{"path":"src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts#L26"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.isGeoPolygonFilter","type":"Function","children":[{"type":"Any","label":"filter","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/geo_polygon_filter.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/geo_polygon_filter.ts#L22"}}],"signature":["(filter: any) => filter is ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.GeoPolygonFilter","text":"GeoPolygonFilter"}],"description":[],"label":"isGeoPolygonFilter","source":{"path":"src/plugins/data/common/es_query/filters/geo_polygon_filter.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/geo_polygon_filter.ts#L22"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getGeoPolygonFilterField","type":"Function","children":[{"type":"CompoundType","label":"filter","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.GeoPolygonFilter","text":"GeoPolygonFilter"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/geo_polygon_filter.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/geo_polygon_filter.ts#L25"}}],"signature":["(filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.GeoPolygonFilter","text":"GeoPolygonFilter"},") => any"],"description":[],"label":"getGeoPolygonFilterField","source":{"path":"src/plugins/data/common/es_query/filters/geo_polygon_filter.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/geo_polygon_filter.ts#L25"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getDisplayValueFromFilter","type":"Function","label":"getDisplayValueFromFilter","signature":["(filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},", indexPatterns: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"},"[]) => string"],"description":[],"children":[{"type":"Object","label":"filter","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/get_display_value.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/get_display_value.ts#L31"}},{"type":"Array","label":"indexPatterns","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"},"[]"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/get_display_value.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/get_display_value.ts#L31"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/es_query/filters/get_display_value.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/get_display_value.ts#L31"},"initialIsOpen":false},{"id":"def-common.getFilterField","type":"Function","children":[{"type":"Object","label":"filter","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/get_filter_field.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/get_filter_field.ts#L18"}}],"signature":["(filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},") => any"],"description":[],"label":"getFilterField","source":{"path":"src/plugins/data/common/es_query/filters/get_filter_field.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/get_filter_field.ts#L18"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getFilterParams","type":"Function","label":"getFilterParams","signature":["(filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},") => any"],"description":[],"children":[{"type":"Object","label":"filter","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/get_filter_params.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/get_filter_params.ts#L11"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/es_query/filters/get_filter_params.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/get_filter_params.ts#L11"},"initialIsOpen":false},{"id":"def-common.getIndexPatternFromFilter","type":"Function","label":"getIndexPatternFromFilter","signature":["(filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},", indexPatterns: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"},"[]) => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"}," | undefined"],"description":[],"children":[{"type":"Object","label":"filter","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/get_index_pattern_from_filter.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/get_index_pattern_from_filter.ts#L13"}},{"type":"Array","label":"indexPatterns","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"},"[]"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/get_index_pattern_from_filter.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/get_index_pattern_from_filter.ts#L14"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/es_query/filters/get_index_pattern_from_filter.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/get_index_pattern_from_filter.ts#L12"},"initialIsOpen":false},{"id":"def-common.isMatchAllFilter","type":"Function","children":[{"type":"Any","label":"filter","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/match_all_filter.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/match_all_filter.ts#L21"}}],"signature":["(filter: any) => filter is ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.MatchAllFilter","text":"MatchAllFilter"}],"description":[],"label":"isMatchAllFilter","source":{"path":"src/plugins/data/common/es_query/filters/match_all_filter.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/match_all_filter.ts#L21"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.buildEmptyFilter","type":"Function","children":[{"type":"boolean","label":"isPinned","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L52"}},{"type":"string","label":"index","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L52"}}],"signature":["(isPinned: boolean, index?: string | undefined) => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}],"description":[],"label":"buildEmptyFilter","source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L52"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.isFilterPinned","type":"Function","children":[{"type":"Object","label":"filter","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L66"}}],"signature":["(filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},") => boolean | undefined"],"description":[],"label":"isFilterPinned","source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L66"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.toggleFilterDisabled","type":"Function","children":[{"type":"Object","label":"filter","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L70"}}],"signature":["(filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},") => { meta: { disabled: boolean; alias: string | null; negate: boolean; controlledBy?: string | undefined; index?: string | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; $state?: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.FilterState","text":"FilterState"}," | undefined; query?: any; }"],"description":[],"label":"toggleFilterDisabled","source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L70"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.toggleFilterNegated","type":"Function","children":[{"type":"Object","label":"filter","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L77"}}],"signature":["(filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},") => { meta: { negate: boolean; alias: string | null; disabled: boolean; controlledBy?: string | undefined; index?: string | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }; $state?: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.FilterState","text":"FilterState"}," | undefined; query?: any; }"],"description":[],"label":"toggleFilterNegated","source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L77"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.toggleFilterPinned","type":"Function","children":[{"type":"Object","label":"filter","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L84"}}],"signature":["(filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},") => { $state: { store: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.FilterStateStore","text":"FilterStateStore"},"; }; meta: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.FilterMeta","text":"FilterMeta"},"; query?: any; }"],"description":[],"label":"toggleFilterPinned","source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L84"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.enableFilter","type":"Function","children":[{"type":"Object","label":"filter","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":91,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L91"}}],"signature":["(filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}],"description":[],"label":"enableFilter","source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":91,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L91"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.disableFilter","type":"Function","children":[{"type":"Object","label":"filter","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L94"}}],"signature":["(filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}],"description":[],"label":"disableFilter","source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L94"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.pinFilter","type":"Function","children":[{"type":"Object","label":"filter","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L97"}}],"signature":["(filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}],"description":[],"label":"pinFilter","source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L97"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.unpinFilter","type":"Function","children":[{"type":"Object","label":"filter","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":100,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L100"}}],"signature":["(filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}],"description":[],"label":"unpinFilter","source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":100,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L100"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.isFilter","type":"Function","children":[{"type":"Unknown","label":"x","isRequired":true,"signature":["unknown"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L103"}}],"signature":["(x: unknown) => x is ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}],"description":[],"label":"isFilter","source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L103"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.isFilters","type":"Function","children":[{"type":"Unknown","label":"x","isRequired":true,"signature":["unknown"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L110"}}],"signature":["(x: unknown) => x is ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]"],"description":[],"label":"isFilters","source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L110"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.isMissingFilter","type":"Function","children":[{"type":"Any","label":"filter","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/missing_filter.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/missing_filter.ts#L18"}}],"signature":["(filter: any) => filter is ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.MissingFilter","text":"MissingFilter"}],"description":[],"label":"isMissingFilter","source":{"path":"src/plugins/data/common/es_query/filters/missing_filter.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/missing_filter.ts#L18"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getMissingFilterField","type":"Function","children":[{"type":"CompoundType","label":"filter","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.MissingFilter","text":"MissingFilter"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/missing_filter.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/missing_filter.ts#L20"}}],"signature":["(filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.MissingFilter","text":"MissingFilter"},") => any"],"description":[],"label":"getMissingFilterField","source":{"path":"src/plugins/data/common/es_query/filters/missing_filter.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/missing_filter.ts#L20"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.isPhraseFilter","type":"Function","children":[{"type":"Any","label":"filter","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/phrase_filter.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L34"}}],"signature":["(filter: any) => filter is ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.PhraseFilter","text":"PhraseFilter"}],"description":[],"label":"isPhraseFilter","source":{"path":"src/plugins/data/common/es_query/filters/phrase_filter.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L34"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.isScriptedPhraseFilter","type":"Function","children":[{"type":"Any","label":"filter","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/phrase_filter.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L46"}}],"signature":["(filter: any) => filter is ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.PhraseFilter","text":"PhraseFilter"}],"description":[],"label":"isScriptedPhraseFilter","source":{"path":"src/plugins/data/common/es_query/filters/phrase_filter.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L46"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getPhraseFilterField","type":"Function","children":[{"type":"CompoundType","label":"filter","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.PhraseFilter","text":"PhraseFilter"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/phrase_filter.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L49"}}],"signature":["(filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.PhraseFilter","text":"PhraseFilter"},") => string"],"description":[],"label":"getPhraseFilterField","source":{"path":"src/plugins/data/common/es_query/filters/phrase_filter.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L49"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getPhraseFilterValue","type":"Function","children":[{"type":"CompoundType","label":"filter","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.PhraseFilter","text":"PhraseFilter"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/phrase_filter.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L54"}}],"signature":["(filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.PhraseFilter","text":"PhraseFilter"},") => PhraseFilterValue"],"description":[],"label":"getPhraseFilterValue","source":{"path":"src/plugins/data/common/es_query/filters/phrase_filter.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L54"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.buildPhraseFilter","type":"Function","children":[{"type":"Object","label":"field","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/phrase_filter.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L61"}},{"type":"Any","label":"value","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/phrase_filter.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L62"}},{"type":"Object","label":"indexPattern","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/phrase_filter.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L63"}}],"signature":["(field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"},", value: any, indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.PhraseFilter","text":"PhraseFilter"}],"description":[],"label":"buildPhraseFilter","source":{"path":"src/plugins/data/common/es_query/filters/phrase_filter.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L60"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getPhraseScript","type":"Function","children":[{"type":"Object","label":"field","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/phrase_filter.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L84"}},{"type":"string","label":"value","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/phrase_filter.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L84"}}],"signature":["(field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"},", value: string) => { script: { source: string; lang: string | undefined; params: { value: any; }; }; }"],"description":[],"label":"getPhraseScript","source":{"path":"src/plugins/data/common/es_query/filters/phrase_filter.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L84"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getConvertedValueForField","type":"Function","children":[{"type":"Object","label":"field","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/phrase_filter.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L102"}},{"type":"Any","label":"value","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/phrase_filter.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L102"}}],"signature":["(field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"},", value: any) => any"],"description":[],"label":"getConvertedValueForField","source":{"path":"src/plugins/data/common/es_query/filters/phrase_filter.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L102"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.buildInlineScriptForPhraseFilter","type":"Function","children":[{"type":"Any","label":"scriptedField","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/phrase_filter.ts","lineNumber":123,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L123"}}],"signature":["(scriptedField: any) => string"],"description":["\nTakes a scripted field and returns an inline script appropriate for use in a script query.\nHandles lucene expression and Painless scripts. Other langs aren't guaranteed to generate valid\nscripts.\n"],"label":"buildInlineScriptForPhraseFilter","source":{"path":"src/plugins/data/common/es_query/filters/phrase_filter.ts","lineNumber":123,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L123"},"returnComment":["The inline script string"],"initialIsOpen":false},{"id":"def-common.isPhrasesFilter","type":"Function","children":[{"type":"Any","label":"filter","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/phrases_filter.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrases_filter.ts#L23"}}],"signature":["(filter: any) => filter is ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.PhrasesFilter","text":"PhrasesFilter"}],"description":[],"label":"isPhrasesFilter","source":{"path":"src/plugins/data/common/es_query/filters/phrases_filter.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrases_filter.ts#L23"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getPhrasesFilterField","type":"Function","children":[{"type":"CompoundType","label":"filter","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.PhrasesFilter","text":"PhrasesFilter"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/phrases_filter.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrases_filter.ts#L26"}}],"signature":["(filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.PhrasesFilter","text":"PhrasesFilter"},") => string | undefined"],"description":[],"label":"getPhrasesFilterField","source":{"path":"src/plugins/data/common/es_query/filters/phrases_filter.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrases_filter.ts#L26"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.buildPhrasesFilter","type":"Function","children":[{"type":"Object","label":"field","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/phrases_filter.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrases_filter.ts#L35"}},{"type":"Array","label":"params","isRequired":true,"signature":["any[]"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/phrases_filter.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrases_filter.ts#L36"}},{"type":"Object","label":"indexPattern","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/phrases_filter.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrases_filter.ts#L37"}}],"signature":["(field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"},", params: any[], indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.PhrasesFilter","text":"PhrasesFilter"}],"description":[],"label":"buildPhrasesFilter","source":{"path":"src/plugins/data/common/es_query/filters/phrases_filter.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrases_filter.ts#L34"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.isQueryStringFilter","type":"Function","children":[{"type":"Any","label":"filter","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/query_string_filter.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/query_string_filter.ts#L22"}}],"signature":["(filter: any) => filter is ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.QueryStringFilter","text":"QueryStringFilter"}],"description":[],"label":"isQueryStringFilter","source":{"path":"src/plugins/data/common/es_query/filters/query_string_filter.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/query_string_filter.ts#L22"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.buildQueryFilter","type":"Function","children":[{"type":"Any","label":"query","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/query_string_filter.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/query_string_filter.ts#L26"}},{"type":"string","label":"index","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/query_string_filter.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/query_string_filter.ts#L26"}},{"type":"string","label":"alias","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/query_string_filter.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/query_string_filter.ts#L26"}}],"signature":["(query: any, index: string, alias: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.QueryStringFilter","text":"QueryStringFilter"}],"description":[],"label":"buildQueryFilter","source":{"path":"src/plugins/data/common/es_query/filters/query_string_filter.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/query_string_filter.ts#L26"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.isRangeFilter","type":"Function","children":[{"type":"Any","label":"filter","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L73"}}],"signature":["(filter: any) => filter is ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.RangeFilter","text":"RangeFilter"}],"description":[],"label":"isRangeFilter","source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L73"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.isScriptedRangeFilter","type":"Function","children":[{"type":"Any","label":"filter","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L75"}}],"signature":["(filter: any) => filter is ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.RangeFilter","text":"RangeFilter"}],"description":[],"label":"isScriptedRangeFilter","source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L75"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getRangeFilterField","type":"Function","children":[{"type":"CompoundType","label":"filter","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.RangeFilter","text":"RangeFilter"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L81"}}],"signature":["(filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.RangeFilter","text":"RangeFilter"},") => string"],"description":[],"label":"getRangeFilterField","source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L81"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.buildRangeFilter","type":"Function","children":[{"type":"Object","label":"field","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L94"}},{"type":"Object","label":"params","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.RangeFilterParams","text":"RangeFilterParams"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L95"}},{"type":"Object","label":"indexPattern","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L96"}},{"type":"string","label":"formattedValue","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L97"}}],"signature":["(field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"},", params: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.RangeFilterParams","text":"RangeFilterParams"},", indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"},", formattedValue?: string | undefined) => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.RangeFilter","text":"RangeFilter"}],"description":[],"label":"buildRangeFilter","source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":93,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L93"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getRangeScript","type":"Function","children":[{"type":"Object","label":"field","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":140,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L140"}},{"type":"Object","label":"params","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.RangeFilterParams","text":"RangeFilterParams"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":140,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L140"}}],"signature":["(field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"},", params: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.RangeFilterParams","text":"RangeFilterParams"},") => { script: { source: string; params: Partial<",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.RangeFilterParams","text":"RangeFilterParams"},">; lang: string | undefined; }; }"],"description":[],"label":"getRangeScript","source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":140,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L140"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.fromLiteralExpression","type":"Function","children":[{"type":"Any","label":"expression","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/ast/ast.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/ast/ast.ts#L31"}},{"type":"Object","label":"parseOptions","isRequired":true,"signature":["Partial<",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KueryParseOptions","text":"KueryParseOptions"},">"],"description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/ast/ast.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/ast/ast.ts#L32"}}],"signature":["(expression: any, parseOptions?: Partial<",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KueryParseOptions","text":"KueryParseOptions"},">) => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KueryNode","text":"KueryNode"}],"description":[],"label":"fromLiteralExpression","source":{"path":"src/plugins/data/common/es_query/kuery/ast/ast.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/ast/ast.ts#L30"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.fromKueryExpression","type":"Function","children":[{"type":"Any","label":"expression","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/ast/ast.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/ast/ast.ts#L45"}},{"type":"Object","label":"parseOptions","isRequired":true,"signature":["Partial<",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KueryParseOptions","text":"KueryParseOptions"},">"],"description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/ast/ast.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/ast/ast.ts#L46"}}],"signature":["(expression: any, parseOptions?: Partial<",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KueryParseOptions","text":"KueryParseOptions"},">) => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KueryNode","text":"KueryNode"}],"description":[],"label":"fromKueryExpression","source":{"path":"src/plugins/data/common/es_query/kuery/ast/ast.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/ast/ast.ts#L44"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.doesKueryExpressionHaveLuceneSyntaxError","type":"Function","children":[{"type":"Any","label":"expression","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/ast/ast.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/ast/ast.ts#L60"}}],"signature":["(expression: any) => boolean"],"description":[],"label":"doesKueryExpressionHaveLuceneSyntaxError","source":{"path":"src/plugins/data/common/es_query/kuery/ast/ast.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/ast/ast.ts#L59"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.toElasticsearchQuery","type":"Function","children":[{"type":"Object","label":"node","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KueryNode","text":"KueryNode"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/ast/ast.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/ast/ast.ts#L78"}},{"type":"Object","label":"indexPattern","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/ast/ast.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/ast/ast.ts#L79"}},{"type":"Object","label":"config","isRequired":false,"signature":["Record | undefined"],"description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/ast/ast.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/ast/ast.ts#L80"}},{"type":"Object","label":"context","isRequired":false,"signature":["Record | undefined"],"description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/ast/ast.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/ast/ast.ts#L81"}}],"signature":["(node: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KueryNode","text":"KueryNode"},", indexPattern?: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"}," | undefined, config?: Record | undefined, context?: Record | undefined) => ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.JsonObject","text":"JsonObject"}],"description":[],"label":"toElasticsearchQuery","source":{"path":"src/plugins/data/common/es_query/kuery/ast/ast.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/ast/ast.ts#L77"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.castEsToKbnFieldTypeName","type":"Function","children":[{"type":"string","label":"esType","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/kbn_field_types/kbn_field_types.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_types.ts#L39"}}],"signature":["(esType: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"}],"description":["\n Get the KbnFieldType name for an esType string\n"],"label":"castEsToKbnFieldTypeName","source":{"path":"src/plugins/data/common/kbn_field_types/kbn_field_types.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_types.ts#L39"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getKbnFieldType","type":"Function","children":[{"type":"string","label":"typeName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/kbn_field_types/kbn_field_types.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_types.ts#L22"}}],"signature":["(typeName: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KbnFieldType","text":"KbnFieldType"}],"description":["\n Get a type object by name\n"],"label":"getKbnFieldType","source":{"path":"src/plugins/data/common/kbn_field_types/kbn_field_types.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_types.ts#L22"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getKbnTypeNames","type":"Function","children":[],"signature":["() => string[]"],"description":["\n Get the esTypes known by all kbnFieldTypes\n"],"label":"getKbnTypeNames","source":{"path":"src/plugins/data/common/kbn_field_types/kbn_field_types.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_types.ts#L30"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getFilterableKbnTypeNames","type":"Function","children":[],"signature":["() => string[]"],"description":["\n Get filterable KbnFieldTypes\n"],"label":"getFilterableKbnTypeNames","source":{"path":"src/plugins/data/common/kbn_field_types/kbn_field_types.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/kbn_field_types.ts#L50"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.shortenDottedString","type":"Function","label":"shortenDottedString","signature":["(input: any) => any"],"description":["\nConvert a dot.notated.string into a short\nversion (d.n.string)\n"],"children":[{"type":"Any","label":"input","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/utils/shorten_dotted_string.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/utils/shorten_dotted_string.ts#L17"}}],"tags":["return"],"returnComment":[],"source":{"path":"src/plugins/data/common/utils/shorten_dotted_string.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/utils/shorten_dotted_string.ts#L17"},"initialIsOpen":false},{"id":"def-common.datatableToCSV","type":"Function","label":"datatableToCSV","signature":["({ columns, rows }: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"},", { csvSeparator, quoteValues, formatFactory, raw }: CSVOptions) => string"],"description":[],"children":[{"type":"Object","label":"{ columns, rows }","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"}],"description":[],"source":{"path":"src/plugins/data/common/exports/export_csv.tsx","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/exports/export_csv.tsx#L42"}},{"type":"Object","label":"{ csvSeparator, quoteValues, formatFactory, raw }","isRequired":true,"signature":["CSVOptions"],"description":[],"source":{"path":"src/plugins/data/common/exports/export_csv.tsx","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/exports/export_csv.tsx#L43"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/exports/export_csv.tsx","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/exports/export_csv.tsx#L41"},"initialIsOpen":false}],"interfaces":[{"id":"def-common.EsQueryConfig","type":"Interface","label":"EsQueryConfig","description":[],"children":[{"id":"def-common.EsQueryConfig.allowLeadingWildcards","type":"boolean","label":"allowLeadingWildcards","description":[],"source":{"path":"src/plugins/data/common/es_query/es_query/build_es_query.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L18"}},{"id":"def-common.EsQueryConfig.queryStringOptions","type":"Object","label":"queryStringOptions","description":[],"source":{"path":"src/plugins/data/common/es_query/es_query/build_es_query.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L19"},"signature":["Record"]},{"id":"def-common.EsQueryConfig.ignoreFilterIfFieldNotInIndex","type":"boolean","label":"ignoreFilterIfFieldNotInIndex","description":[],"source":{"path":"src/plugins/data/common/es_query/es_query/build_es_query.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L20"}},{"id":"def-common.EsQueryConfig.dateFormatTZ","type":"string","label":"dateFormatTZ","description":[],"source":{"path":"src/plugins/data/common/es_query/es_query/build_es_query.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L21"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/data/common/es_query/es_query/build_es_query.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/es_query/build_es_query.ts#L17"},"initialIsOpen":false},{"id":"def-common.FilterExistsProperty","type":"Interface","label":"FilterExistsProperty","description":[],"children":[{"id":"def-common.FilterExistsProperty.field","type":"Any","label":"field","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/exists_filter.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/exists_filter.ts#L15"},"signature":["any"]}],"source":{"path":"src/plugins/data/common/es_query/filters/exists_filter.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/exists_filter.ts#L14"},"initialIsOpen":false},{"id":"def-common.MatchAllFilterMeta","type":"Interface","label":"MatchAllFilterMeta","signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.MatchAllFilterMeta","text":"MatchAllFilterMeta"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.FilterMeta","text":"FilterMeta"}],"description":[],"children":[{"id":"def-common.MatchAllFilterMeta.field","type":"Any","label":"field","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/match_all_filter.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/match_all_filter.ts#L12"},"signature":["any"]},{"id":"def-common.MatchAllFilterMeta.formattedValue","type":"string","label":"formattedValue","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/match_all_filter.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/match_all_filter.ts#L13"}}],"source":{"path":"src/plugins/data/common/es_query/filters/match_all_filter.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/match_all_filter.ts#L11"},"initialIsOpen":false},{"id":"def-common.FilterValueFormatter","type":"Interface","label":"FilterValueFormatter","description":[],"children":[{"id":"def-common.FilterValueFormatter.convert","type":"Function","label":"convert","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L21"},"signature":["FilterFormatterFunction"]},{"id":"def-common.FilterValueFormatter.getConverterFor","type":"Function","label":"getConverterFor","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L22"},"signature":["(type: string) => FilterFormatterFunction"]}],"source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L20"},"initialIsOpen":false},{"id":"def-common.LatLon","type":"Interface","label":"LatLon","description":[],"children":[{"id":"def-common.LatLon.lat","type":"number","label":"lat","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L48"}},{"id":"def-common.LatLon.lon","type":"number","label":"lon","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L49"}}],"source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L47"},"initialIsOpen":false},{"id":"def-common.RangeFilterParams","type":"Interface","label":"RangeFilterParams","description":[],"children":[{"id":"def-common.RangeFilterParams.from","type":"CompoundType","label":"from","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L36"},"signature":["string | number | undefined"]},{"id":"def-common.RangeFilterParams.to","type":"CompoundType","label":"to","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L37"},"signature":["string | number | undefined"]},{"id":"def-common.RangeFilterParams.gt","type":"CompoundType","label":"gt","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L38"},"signature":["string | number | undefined"]},{"id":"def-common.RangeFilterParams.lt","type":"CompoundType","label":"lt","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L39"},"signature":["string | number | undefined"]},{"id":"def-common.RangeFilterParams.gte","type":"CompoundType","label":"gte","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L40"},"signature":["string | number | undefined"]},{"id":"def-common.RangeFilterParams.lte","type":"CompoundType","label":"lte","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L41"},"signature":["string | number | undefined"]},{"id":"def-common.RangeFilterParams.format","type":"string","label":"format","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L42"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L35"},"initialIsOpen":false},{"id":"def-common.EsRangeFilter","type":"Interface","label":"EsRangeFilter","description":[],"children":[{"id":"def-common.EsRangeFilter.range","type":"Object","label":"range","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L57"},"signature":["{ [key: string]: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.RangeFilterParams","text":"RangeFilterParams"},"; }"]}],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L56"},"initialIsOpen":false},{"id":"def-common.KueryNode","type":"Interface","label":"KueryNode","description":[],"children":[{"id":"def-common.KueryNode.type","type":"CompoundType","label":"type","description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/types.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L12"},"signature":["\"function\" | \"literal\" | \"namedArg\" | \"wildcard\""]},{"id":"def-common.KueryNode.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L13"},"signature":["any"]}],"source":{"path":"src/plugins/data/common/es_query/kuery/types.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L11"},"initialIsOpen":false},{"id":"def-common.KueryParseOptions","type":"Interface","label":"KueryParseOptions","description":[],"children":[{"id":"def-common.KueryParseOptions.helpers","type":"Object","label":"helpers","description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L19"},"signature":["{ [key: string]: any; }"]},{"id":"def-common.KueryParseOptions.startRule","type":"string","label":"startRule","description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/types.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L22"}},{"id":"def-common.KueryParseOptions.allowLeadingWildcards","type":"boolean","label":"allowLeadingWildcards","description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/types.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L23"}},{"id":"def-common.KueryParseOptions.errorOnLuceneSyntax","type":"boolean","label":"errorOnLuceneSyntax","description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/types.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L24"}},{"id":"def-common.KueryParseOptions.cursorSymbol","type":"string","label":"cursorSymbol","description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/types.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L25"},"signature":["string | undefined"]},{"id":"def-common.KueryParseOptions.parseCursor","type":"CompoundType","label":"parseCursor","description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/types.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L26"},"signature":["boolean | undefined"]}],"source":{"path":"src/plugins/data/common/es_query/kuery/types.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L18"},"initialIsOpen":false},{"id":"def-common.SavedObject","type":"Interface","label":"SavedObject","signature":["SavedObject",""],"description":[],"children":[{"id":"def-common.SavedObject.id","type":"string","label":"id","description":["The ID of this Saved Object, guaranteed to be unique for all objects of the same `type`"],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L71"}},{"id":"def-common.SavedObject.type","type":"string","label":"type","description":[" The type of Saved Object. Each plugin can define it's own custom Saved Object types."],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L73"}},{"id":"def-common.SavedObject.version","type":"string","label":"version","description":["An opaque version number which changes on each successful write operation. Can be used for implementing optimistic concurrency control."],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L75"},"signature":["string | undefined"]},{"id":"def-common.SavedObject.updated_at","type":"string","label":"updated_at","description":["Timestamp of the last time this document had been updated."],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L77"},"signature":["string | undefined"]},{"id":"def-common.SavedObject.error","type":"Object","label":"error","description":[],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L78"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectError","text":"SavedObjectError"}," | undefined"]},{"id":"def-common.SavedObject.attributes","type":"Uncategorized","label":"attributes","description":["{@inheritdoc SavedObjectAttributes}"],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L80"},"signature":["T"]},{"id":"def-common.SavedObject.references","type":"Array","label":"references","description":["{@inheritdoc SavedObjectReference}"],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L82"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[]"]},{"id":"def-common.SavedObject.migrationVersion","type":"Object","label":"migrationVersion","description":["{@inheritdoc SavedObjectsMigrationVersion}"],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L84"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectsMigrationVersion","text":"SavedObjectsMigrationVersion"}," | undefined"]},{"id":"def-common.SavedObject.coreMigrationVersion","type":"string","label":"coreMigrationVersion","description":["A semver value that is used when upgrading objects between Kibana versions."],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L86"},"signature":["string | undefined"]},{"id":"def-common.SavedObject.namespaces","type":"Array","label":"namespaces","description":["Namespace(s) that this saved object exists in. This attribute is only used for multi-namespace saved object types."],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L88"},"signature":["string[] | undefined"]},{"id":"def-common.SavedObject.originId","type":"string","label":"originId","description":["\nThe ID of the saved object this originated from. This is set if this object's `id` was regenerated; that can happen during migration\nfrom a legacy single-namespace type, or during import. It is only set during migration or create operations. This is used during import\nto ensure that ID regeneration is deterministic, so saved objects will be overwritten if they are imported multiple times into a given\nspace."],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L95"},"signature":["string | undefined"]}],"source":{"path":"src/core/types/saved_objects.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/core/types/saved_objects.ts#L69"},"initialIsOpen":false},{"id":"def-common.KbnFieldTypeOptions","type":"Interface","label":"KbnFieldTypeOptions","description":[],"children":[{"id":"def-common.KbnFieldTypeOptions.sortable","type":"boolean","label":"sortable","description":[],"source":{"path":"src/plugins/data/common/kbn_field_types/types.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/types.ts#L11"}},{"id":"def-common.KbnFieldTypeOptions.filterable","type":"boolean","label":"filterable","description":[],"source":{"path":"src/plugins/data/common/kbn_field_types/types.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/types.ts#L12"}},{"id":"def-common.KbnFieldTypeOptions.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/data/common/kbn_field_types/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/types.ts#L13"}},{"id":"def-common.KbnFieldTypeOptions.esTypes","type":"Array","label":"esTypes","description":[],"source":{"path":"src/plugins/data/common/kbn_field_types/types.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/types.ts#L14"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ES_FIELD_TYPES","text":"ES_FIELD_TYPES"},"[]"]}],"source":{"path":"src/plugins/data/common/kbn_field_types/types.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/types.ts#L10"},"initialIsOpen":false}],"enums":[{"id":"def-common.FilterStateStore","type":"Enum","label":"FilterStateStore","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L9"},"initialIsOpen":false},{"id":"def-common.FILTERS","type":"Enum","label":"FILTERS","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/types.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/types.ts#L29"},"initialIsOpen":false},{"id":"def-common.ES_FIELD_TYPES","type":"Enum","label":"ES_FIELD_TYPES","description":[],"source":{"path":"src/plugins/data/common/kbn_field_types/types.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/types.ts#L18"},"initialIsOpen":false},{"id":"def-common.KBN_FIELD_TYPES","type":"Enum","label":"KBN_FIELD_TYPES","description":[],"source":{"path":"src/plugins/data/common/kbn_field_types/types.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/kbn_field_types/types.ts#L57"},"initialIsOpen":false}],"misc":[{"id":"def-common.DEFAULT_QUERY_LANGUAGE","type":"string","label":"DEFAULT_QUERY_LANGUAGE","description":[],"source":{"path":"src/plugins/data/common/constants.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/constants.ts#L9"},"signature":["\"kuery\""],"initialIsOpen":false},{"id":"def-common.CustomFilter","type":"Type","label":"CustomFilter","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/custom_filter.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/custom_filter.ts#L11"},"signature":["Filter & { query: any; }"],"initialIsOpen":false},{"id":"def-common.ExistsFilterMeta","type":"Type","label":"ExistsFilterMeta","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/exists_filter.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/exists_filter.ts#L12"},"signature":["{ alias: string | null; disabled: boolean; negate: boolean; controlledBy?: string | undefined; index?: string | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }"],"initialIsOpen":false},{"id":"def-common.ExistsFilter","type":"Type","label":"ExistsFilter","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/exists_filter.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/exists_filter.ts#L18"},"signature":["Filter & { meta: ExistsFilterMeta; exists?: FilterExistsProperty | undefined; }"],"initialIsOpen":false},{"id":"def-common.GeoBoundingBoxFilterMeta","type":"Type","label":"GeoBoundingBoxFilterMeta","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts#L11"},"signature":["FilterMeta & { params: { bottom_right: LatLon; top_left: LatLon;}; }"],"initialIsOpen":false},{"id":"def-common.GeoBoundingBoxFilter","type":"Type","label":"GeoBoundingBoxFilter","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/geo_bounding_box_filter.ts#L18"},"signature":["Filter & { meta: GeoBoundingBoxFilterMeta; geo_bounding_box: any; }"],"initialIsOpen":false},{"id":"def-common.GeoPolygonFilterMeta","type":"Type","label":"GeoPolygonFilterMeta","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/geo_polygon_filter.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/geo_polygon_filter.ts#L11"},"signature":["FilterMeta & { params: { points: LatLon[];}; }"],"initialIsOpen":false},{"id":"def-common.GeoPolygonFilter","type":"Type","label":"GeoPolygonFilter","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/geo_polygon_filter.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/geo_polygon_filter.ts#L17"},"signature":["Filter & { meta: GeoPolygonFilterMeta; geo_polygon: any; }"],"initialIsOpen":false},{"id":"def-common.MatchAllFilter","type":"Type","label":"MatchAllFilter","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/match_all_filter.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/match_all_filter.ts#L16"},"signature":["Filter & { meta: MatchAllFilterMeta; match_all: any; }"],"initialIsOpen":false},{"id":"def-common.FilterState","type":"Type","label":"FilterState","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L15"},"signature":["{ store: FilterStateStore; }"],"initialIsOpen":false},{"id":"def-common.FilterMeta","type":"Type","label":"FilterMeta","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L26"},"signature":["{ alias: string | null; disabled: boolean; negate: boolean; controlledBy?: string | undefined; index?: string | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }"],"initialIsOpen":false},{"id":"def-common.Filter","type":"Type","label":"Filter","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/meta_filter.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/meta_filter.ts#L41"},"signature":["{ $state?: FilterState | undefined; meta: FilterMeta; query?: any; }"],"initialIsOpen":false},{"id":"def-common.MissingFilterMeta","type":"Type","label":"MissingFilterMeta","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/missing_filter.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/missing_filter.ts#L11"},"signature":["{ alias: string | null; disabled: boolean; negate: boolean; controlledBy?: string | undefined; index?: string | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }"],"initialIsOpen":false},{"id":"def-common.MissingFilter","type":"Type","label":"MissingFilter","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/missing_filter.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/missing_filter.ts#L13"},"signature":["Filter & { meta: MissingFilterMeta; missing: any; }"],"initialIsOpen":false},{"id":"def-common.PhraseFilterMeta","type":"Type","label":"PhraseFilterMeta","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/phrase_filter.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L13"},"signature":["FilterMeta & { params?: { query: string; } | undefined; field?: any; index?: any; }"],"initialIsOpen":false},{"id":"def-common.PhraseFilter","type":"Type","label":"PhraseFilter","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/phrase_filter.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrase_filter.ts#L21"},"signature":["Filter & { meta: PhraseFilterMeta; script?: { script: { source?: any; lang?: string; params: any;}; } | undefined; }"],"initialIsOpen":false},{"id":"def-common.PhrasesFilterMeta","type":"Type","label":"PhrasesFilterMeta","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/phrases_filter.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrases_filter.ts#L14"},"signature":["FilterMeta & { params: string[]; field?: string | undefined; }"],"initialIsOpen":false},{"id":"def-common.PhrasesFilter","type":"Type","label":"PhrasesFilter","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/phrases_filter.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/phrases_filter.ts#L19"},"signature":["Filter & { meta: PhrasesFilterMeta; }"],"initialIsOpen":false},{"id":"def-common.QueryStringFilterMeta","type":"Type","label":"QueryStringFilterMeta","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/query_string_filter.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/query_string_filter.ts#L11"},"signature":["{ alias: string | null; disabled: boolean; negate: boolean; controlledBy?: string | undefined; index?: string | undefined; type?: string | undefined; key?: string | undefined; params?: any; value?: string | undefined; }"],"initialIsOpen":false},{"id":"def-common.QueryStringFilter","type":"Type","label":"QueryStringFilter","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/query_string_filter.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/query_string_filter.ts#L13"},"signature":["Filter & { meta: QueryStringFilterMeta; query?: { query_string: { query: string;}; } | undefined; }"],"initialIsOpen":false},{"id":"def-common.RangeFilterMeta","type":"Type","label":"RangeFilterMeta","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L50"},"signature":["FilterMeta & { params: RangeFilterParams; field?: any; formattedValue?: string | undefined; }"],"initialIsOpen":false},{"id":"def-common.RangeFilter","type":"Type","label":"RangeFilter","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/range_filter.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/range_filter.ts#L60"},"signature":["Filter & EsRangeFilter & { meta: RangeFilterMeta; script?: { script: { params: any; lang: string; source: any;}; } | undefined; match_all?: any; }"],"initialIsOpen":false},{"id":"def-common.FieldFilter","type":"Type","label":"FieldFilter","description":[],"source":{"path":"src/plugins/data/common/es_query/filters/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/filters/types.ts#L19"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.PhrasesFilter","text":"PhrasesFilter"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ExistsFilter","text":"ExistsFilter"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.PhraseFilter","text":"PhraseFilter"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.RangeFilter","text":"RangeFilter"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.MatchAllFilter","text":"MatchAllFilter"}],"initialIsOpen":false},{"id":"def-common.DslQuery","type":"Type","label":"DslQuery","description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/types.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/types.ts#L16"},"signature":["any"],"initialIsOpen":false},{"id":"def-common.GetConfigFn","type":"Type","label":"GetConfigFn","description":["\nIf a service is being shared on both the client and the server, and\nthe client code requires synchronous access to uiSettings, both client\nand server should wrap the core uiSettings services in a function\nmatching this signature.\n\nThis matches the signature of the public `core.uiSettings.get`, and\nshould only be used in scenarios where async access to uiSettings is\nnot possible."],"source":{"path":"src/plugins/data/common/types.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/types.ts#L23"},"signature":["(key: string, defaultOverride: T | undefined) => T"],"initialIsOpen":false},{"id":"def-common.CSV_MIME_TYPE","type":"string","label":"CSV_MIME_TYPE","description":[],"source":{"path":"src/plugins/data/common/exports/export_csv.tsx","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/exports/export_csv.tsx#L17"},"signature":["\"text/plain;charset=utf-8\""],"initialIsOpen":false}],"objects":[{"id":"def-common.UI_SETTINGS","type":"Object","label":"UI_SETTINGS","description":[],"source":{"path":"src/plugins/data/common/constants.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/constants.ts#L11"},"signature":["{ readonly META_FIELDS: \"metaFields\"; readonly DOC_HIGHLIGHT: \"doc_table:highlight\"; readonly QUERY_STRING_OPTIONS: \"query:queryString:options\"; readonly QUERY_ALLOW_LEADING_WILDCARDS: \"query:allowLeadingWildcards\"; readonly SEARCH_QUERY_LANGUAGE: \"search:queryLanguage\"; readonly SORT_OPTIONS: \"sort:options\"; readonly COURIER_IGNORE_FILTER_IF_FIELD_NOT_IN_INDEX: \"courier:ignoreFilterIfFieldNotInIndex\"; readonly COURIER_SET_REQUEST_PREFERENCE: \"courier:setRequestPreference\"; readonly COURIER_CUSTOM_REQUEST_PREFERENCE: \"courier:customRequestPreference\"; readonly COURIER_MAX_CONCURRENT_SHARD_REQUESTS: \"courier:maxConcurrentShardRequests\"; readonly COURIER_BATCH_SEARCHES: \"courier:batchSearches\"; readonly SEARCH_INCLUDE_FROZEN: \"search:includeFrozen\"; readonly SEARCH_TIMEOUT: \"search:timeout\"; readonly HISTOGRAM_BAR_TARGET: \"histogram:barTarget\"; readonly HISTOGRAM_MAX_BARS: \"histogram:maxBars\"; readonly HISTORY_LIMIT: \"history:limit\"; readonly SHORT_DOTS_ENABLE: \"shortDots:enable\"; readonly FORMAT_DEFAULT_TYPE_MAP: \"format:defaultTypeMap\"; readonly FORMAT_NUMBER_DEFAULT_PATTERN: \"format:number:defaultPattern\"; readonly FORMAT_PERCENT_DEFAULT_PATTERN: \"format:percent:defaultPattern\"; readonly FORMAT_BYTES_DEFAULT_PATTERN: \"format:bytes:defaultPattern\"; readonly FORMAT_CURRENCY_DEFAULT_PATTERN: \"format:currency:defaultPattern\"; readonly FORMAT_NUMBER_DEFAULT_LOCALE: \"format:number:defaultLocale\"; readonly TIMEPICKER_REFRESH_INTERVAL_DEFAULTS: \"timepicker:refreshIntervalDefaults\"; readonly TIMEPICKER_QUICK_RANGES: \"timepicker:quickRanges\"; readonly TIMEPICKER_TIME_DEFAULTS: \"timepicker:timeDefaults\"; readonly INDEXPATTERN_PLACEHOLDER: \"indexPattern:placeholder\"; readonly FILTERS_PINNED_BY_DEFAULT: \"filters:pinnedByDefault\"; readonly FILTERS_EDITOR_SUGGEST_VALUES: \"filterEditor:suggestValues\"; readonly AUTOCOMPLETE_USE_TIMERANGE: \"autocomplete:useTimeRange\"; }"],"initialIsOpen":false},{"id":"def-common.nodeTypes","type":"Object","children":[{"id":"def-common.nodeTypes.function","type":"Object","label":"function","description":["// This requires better typing of the different typings and their return types.\n// @ts-ignore"],"source":{"path":"src/plugins/data/common/es_query/kuery/node_types/index.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/node_types/index.ts#L21"},"signature":["typeof import(\"/Users/gammon/Elastic/kibana2/src/plugins/data/common/es_query/kuery/node_types/function\")"]},{"id":"def-common.nodeTypes.literal","type":"Object","label":"literal","description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/node_types/index.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/node_types/index.ts#L22"},"signature":["typeof import(\"/Users/gammon/Elastic/kibana2/src/plugins/data/common/es_query/kuery/node_types/literal\")"]},{"id":"def-common.nodeTypes.namedArg","type":"Object","label":"namedArg","description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/node_types/index.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/node_types/index.ts#L23"},"signature":["typeof import(\"/Users/gammon/Elastic/kibana2/src/plugins/data/common/es_query/kuery/node_types/named_arg\")"]},{"id":"def-common.nodeTypes.wildcard","type":"Object","label":"wildcard","description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/node_types/index.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/node_types/index.ts#L24"},"signature":["typeof import(\"/Users/gammon/Elastic/kibana2/src/plugins/data/common/es_query/kuery/node_types/wildcard\")"]}],"description":[],"label":"nodeTypes","source":{"path":"src/plugins/data/common/es_query/kuery/node_types/index.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/node_types/index.ts#L18"},"initialIsOpen":false},{"id":"def-common.nodeBuilder","type":"Object","children":[{"id":"def-common.nodeBuilder.is","type":"Function","children":[{"type":"string","label":"fieldName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/node_types/node_builder.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/node_types/node_builder.ts#L12"}},{"type":"CompoundType","label":"value","isRequired":true,"signature":["string | ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KueryNode","text":"KueryNode"}],"description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/node_types/node_builder.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/node_types/node_builder.ts#L12"}}],"signature":["(fieldName: string, value: string | ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KueryNode","text":"KueryNode"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.FunctionTypeBuildNode","text":"FunctionTypeBuildNode"}],"description":[],"label":"is","source":{"path":"src/plugins/data/common/es_query/kuery/node_types/node_builder.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/node_types/node_builder.ts#L12"},"returnComment":[]},{"id":"def-common.nodeBuilder.or","type":"Function","children":[{"type":"Array","label":"nodes","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KueryNode","text":"KueryNode"},"[]"],"description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/node_types/node_builder.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/node_types/node_builder.ts#L19"}}],"signature":["(nodes: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KueryNode","text":"KueryNode"},"[]) => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KueryNode","text":"KueryNode"}],"description":[],"label":"or","source":{"path":"src/plugins/data/common/es_query/kuery/node_types/node_builder.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/node_types/node_builder.ts#L19"},"returnComment":[]},{"id":"def-common.nodeBuilder.and","type":"Function","children":[{"type":"Array","label":"nodes","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KueryNode","text":"KueryNode"},"[]"],"description":[],"source":{"path":"src/plugins/data/common/es_query/kuery/node_types/node_builder.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/node_types/node_builder.ts#L22"}}],"signature":["(nodes: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KueryNode","text":"KueryNode"},"[]) => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KueryNode","text":"KueryNode"}],"description":[],"label":"and","source":{"path":"src/plugins/data/common/es_query/kuery/node_types/node_builder.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/node_types/node_builder.ts#L22"},"returnComment":[]}],"description":[],"label":"nodeBuilder","source":{"path":"src/plugins/data/common/es_query/kuery/node_types/node_builder.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/es_query/kuery/node_types/node_builder.ts#L11"},"initialIsOpen":false}]}} \ No newline at end of file diff --git a/api_docs/data.mdx b/api_docs/data.mdx new file mode 100644 index 0000000000000..583e4a76c099e --- /dev/null +++ b/api_docs/data.mdx @@ -0,0 +1,62 @@ +--- +id: kibDataPluginApi +slug: /kibana-dev-docs/dataPluginApi +title: data +image: https://source.unsplash.com/400x175/?github +summary: API docs for the data plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data'] +--- + +import dataObj from './data.json'; + +## Client + +### Setup + +### Start + +### Objects + +### Functions + +### Classes + +### Interfaces + +### Enums + +### Consts, variables and types + +## Server + +### Setup + +### Start + +### Objects + +### Functions + +### Classes + +### Interfaces + +### Enums + +### Consts, variables and types + +## Common + +### Objects + +### Functions + +### Classes + +### Interfaces + +### Enums + +### Consts, variables and types + diff --git a/api_docs/data_autocomplete.json b/api_docs/data_autocomplete.json new file mode 100644 index 0000000000000..7f1e5d7e438a8 --- /dev/null +++ b/api_docs/data_autocomplete.json @@ -0,0 +1 @@ +{"id":"data.autocomplete","client":{"classes":[],"functions":[],"interfaces":[{"id":"def-public.QuerySuggestionGetFnArgs","type":"Interface","label":"QuerySuggestionGetFnArgs","description":[],"children":[{"id":"def-public.QuerySuggestionGetFnArgs.language","type":"string","label":"language","description":[],"source":{"path":"src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L25"}},{"id":"def-public.QuerySuggestionGetFnArgs.indexPatterns","type":"Array","label":"indexPatterns","description":[],"source":{"path":"src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L26"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"},"[]"]},{"id":"def-public.QuerySuggestionGetFnArgs.query","type":"string","label":"query","description":[],"source":{"path":"src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L27"}},{"id":"def-public.QuerySuggestionGetFnArgs.selectionStart","type":"number","label":"selectionStart","description":[],"source":{"path":"src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L28"}},{"id":"def-public.QuerySuggestionGetFnArgs.selectionEnd","type":"number","label":"selectionEnd","description":[],"source":{"path":"src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L29"}},{"id":"def-public.QuerySuggestionGetFnArgs.signal","type":"Object","label":"signal","description":[],"source":{"path":"src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L30"},"signature":["AbortSignal | undefined"]},{"id":"def-public.QuerySuggestionGetFnArgs.useTimeRange","type":"CompoundType","label":"useTimeRange","description":[],"source":{"path":"src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L31"},"signature":["boolean | undefined"]},{"id":"def-public.QuerySuggestionGetFnArgs.boolFilter","type":"Any","label":"boolFilter","description":[],"source":{"path":"src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L32"},"signature":["any"]}],"source":{"path":"src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L24"},"initialIsOpen":false},{"id":"def-public.QuerySuggestionBasic","type":"Interface","label":"QuerySuggestionBasic","description":[],"children":[{"id":"def-public.QuerySuggestionBasic.type","type":"Enum","label":"type","description":[],"source":{"path":"src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L37"},"signature":[{"pluginId":"data","scope":"public","docId":"kibDataAutocompletePluginApi","section":"def-public.QuerySuggestionTypes","text":"QuerySuggestionTypes"}]},{"id":"def-public.QuerySuggestionBasic.description","type":"CompoundType","label":"description","description":[],"source":{"path":"src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L38"},"signature":["string | JSX.Element | undefined"]},{"id":"def-public.QuerySuggestionBasic.end","type":"number","label":"end","description":[],"source":{"path":"src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L39"}},{"id":"def-public.QuerySuggestionBasic.start","type":"number","label":"start","description":[],"source":{"path":"src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L40"}},{"id":"def-public.QuerySuggestionBasic.text","type":"string","label":"text","description":[],"source":{"path":"src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L41"}},{"id":"def-public.QuerySuggestionBasic.cursorIndex","type":"number","label":"cursorIndex","description":[],"source":{"path":"src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L42"},"signature":["number | undefined"]}],"source":{"path":"src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L36"},"initialIsOpen":false},{"id":"def-public.QuerySuggestionField","type":"Interface","label":"QuerySuggestionField","signature":[{"pluginId":"data","scope":"public","docId":"kibDataAutocompletePluginApi","section":"def-public.QuerySuggestionField","text":"QuerySuggestionField"}," extends ",{"pluginId":"data","scope":"public","docId":"kibDataAutocompletePluginApi","section":"def-public.QuerySuggestionBasic","text":"QuerySuggestionBasic"}],"description":[],"children":[{"id":"def-public.QuerySuggestionField.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L47"},"signature":[{"pluginId":"data","scope":"public","docId":"kibDataAutocompletePluginApi","section":"def-public.QuerySuggestionTypes","text":"QuerySuggestionTypes"},".Field"]},{"id":"def-public.QuerySuggestionField.field","type":"Object","label":"field","description":[],"source":{"path":"src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L48"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}]}],"source":{"path":"src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L46"},"initialIsOpen":false}],"enums":[{"id":"def-public.QuerySuggestionTypes","type":"Enum","label":"QuerySuggestionTypes","description":[],"source":{"path":"src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L11"},"initialIsOpen":false}],"misc":[{"id":"def-public.QuerySuggestion","type":"Type","label":"QuerySuggestion","description":[],"source":{"path":"src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L52"},"signature":[{"pluginId":"data","scope":"public","docId":"kibDataAutocompletePluginApi","section":"def-public.QuerySuggestionBasic","text":"QuerySuggestionBasic"}," | ",{"pluginId":"data","scope":"public","docId":"kibDataAutocompletePluginApi","section":"def-public.QuerySuggestionField","text":"QuerySuggestionField"}],"initialIsOpen":false},{"id":"def-public.QuerySuggestionGetFn","type":"Type","label":"QuerySuggestionGetFn","description":[],"source":{"path":"src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts#L19"},"signature":["(args: ",{"pluginId":"data","scope":"public","docId":"kibDataAutocompletePluginApi","section":"def-public.QuerySuggestionGetFnArgs","text":"QuerySuggestionGetFnArgs"},") => Promise<",{"pluginId":"data","scope":"public","docId":"kibDataAutocompletePluginApi","section":"def-public.QuerySuggestion","text":"QuerySuggestion"},"[]> | undefined"],"initialIsOpen":false},{"id":"def-public.AutocompleteStart","type":"Type","label":"AutocompleteStart","description":[],"source":{"path":"src/plugins/data/public/autocomplete/autocomplete_service.ts","lineNumber":93,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/autocomplete/autocomplete_service.ts#L93"},"signature":["{ getQuerySuggestions: QuerySuggestionGetFn; hasQuerySuggestions: (language: string) => boolean; getValueSuggestions: ValueSuggestionsGetFn; }"],"initialIsOpen":false}],"objects":[]},"server":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]}} \ No newline at end of file diff --git a/api_docs/data_autocomplete.mdx b/api_docs/data_autocomplete.mdx new file mode 100644 index 0000000000000..6aa8817d7810a --- /dev/null +++ b/api_docs/data_autocomplete.mdx @@ -0,0 +1,20 @@ +--- +id: kibDataAutocompletePluginApi +slug: /kibana-dev-docs/data.autocompletePluginApi +title: data.autocomplete +image: https://source.unsplash.com/400x175/?github +summary: API docs for the data.autocomplete plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.autocomplete'] +--- + +import dataAutocompleteObj from './data_autocomplete.json'; + +## Client + +### Interfaces + +### Enums + +### Consts, variables and types + diff --git a/api_docs/data_enhanced.json b/api_docs/data_enhanced.json new file mode 100644 index 0000000000000..f0037c8374f7d --- /dev/null +++ b/api_docs/data_enhanced.json @@ -0,0 +1 @@ +{"id":"dataEnhanced","client":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[{"id":"def-public.ENHANCED_ES_SEARCH_STRATEGY","type":"string","label":"ENHANCED_ES_SEARCH_STRATEGY","description":[],"source":{"path":"x-pack/plugins/data_enhanced/common/search/types.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L17"},"signature":["\"ese\""],"initialIsOpen":false},{"id":"def-public.EQL_SEARCH_STRATEGY","type":"string","label":"EQL_SEARCH_STRATEGY","description":[],"source":{"path":"x-pack/plugins/data_enhanced/common/search/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L19"},"signature":["\"eql\""],"initialIsOpen":false}],"objects":[],"start":{"id":"def-public.DataEnhancedStart","type":"Type","label":"DataEnhancedStart","description":[],"source":{"path":"x-pack/plugins/data_enhanced/public/plugin.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/public/plugin.ts#L40"},"signature":["void"],"lifecycle":"start","initialIsOpen":true}},"server":{"classes":[{"id":"def-server.EnhancedDataServerPlugin","type":"Class","label":"EnhancedDataServerPlugin","description":[],"signature":[{"pluginId":"dataEnhanced","scope":"server","docId":"kibDataEnhancedPluginApi","section":"def-server.EnhancedDataServerPlugin","text":"EnhancedDataServerPlugin"}," implements ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.Plugin","text":"Plugin"},""],"children":[{"id":"def-server.EnhancedDataServerPlugin.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"initializerContext","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.PluginInitializerContext","text":"PluginInitializerContext"},"; pageSize: number; trackingInterval: moment.Duration; notTouchedTimeout: moment.Duration; notTouchedInProgressTimeout: moment.Duration; maxUpdateRetries: number; defaultExpiration: moment.Duration; }>; }>; }>>"],"description":[],"source":{"path":"x-pack/plugins/data_enhanced/server/plugin.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/server/plugin.ts#L48"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/data_enhanced/server/plugin.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/server/plugin.ts#L48"}},{"id":"def-server.EnhancedDataServerPlugin.setup","type":"Function","label":"setup","signature":["(core: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreSetup","text":"CoreSetup"},"<",{"pluginId":"data","scope":"server","docId":"kibDataPluginApi","section":"def-server.DataPluginStart","text":"DataPluginStart"},", unknown>, deps: SetupDependencies) => void"],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreSetup","text":"CoreSetup"},"<",{"pluginId":"data","scope":"server","docId":"kibDataPluginApi","section":"def-server.DataPluginStart","text":"DataPluginStart"},", unknown>"],"description":[],"source":{"path":"x-pack/plugins/data_enhanced/server/plugin.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/server/plugin.ts#L53"}},{"type":"Object","label":"deps","isRequired":true,"signature":["SetupDependencies"],"description":[],"source":{"path":"x-pack/plugins/data_enhanced/server/plugin.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/server/plugin.ts#L53"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/data_enhanced/server/plugin.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/server/plugin.ts#L53"}},{"id":"def-server.EnhancedDataServerPlugin.start","type":"Function","label":"start","signature":["(core: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreStart","text":"CoreStart"},", { taskManager }: ",{"pluginId":"dataEnhanced","scope":"server","docId":"kibDataEnhancedPluginApi","section":"def-server.StartDependencies","text":"StartDependencies"},") => void"],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreStart","text":"CoreStart"}],"description":[],"source":{"path":"x-pack/plugins/data_enhanced/server/plugin.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/server/plugin.ts#L95"}},{"type":"Object","label":"{ taskManager }","isRequired":true,"signature":[{"pluginId":"dataEnhanced","scope":"server","docId":"kibDataEnhancedPluginApi","section":"def-server.StartDependencies","text":"StartDependencies"}],"description":[],"source":{"path":"x-pack/plugins/data_enhanced/server/plugin.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/server/plugin.ts#L95"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/data_enhanced/server/plugin.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/server/plugin.ts#L95"}},{"id":"def-server.EnhancedDataServerPlugin.stop","type":"Function","label":"stop","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/data_enhanced/server/plugin.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/server/plugin.ts#L101"}}],"source":{"path":"x-pack/plugins/data_enhanced/server/plugin.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/server/plugin.ts#L42"},"initialIsOpen":false}],"functions":[],"interfaces":[],"enums":[],"misc":[{"id":"def-server.ENHANCED_ES_SEARCH_STRATEGY","type":"string","label":"ENHANCED_ES_SEARCH_STRATEGY","description":[],"source":{"path":"x-pack/plugins/data_enhanced/common/search/types.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L17"},"signature":["\"ese\""],"initialIsOpen":false},{"id":"def-server.EQL_SEARCH_STRATEGY","type":"string","label":"EQL_SEARCH_STRATEGY","description":[],"source":{"path":"x-pack/plugins/data_enhanced/common/search/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L19"},"signature":["\"eql\""],"initialIsOpen":false}],"objects":[]},"common":{"classes":[],"functions":[{"id":"def-common.pollSearch","type":"Function","children":[{"type":"Function","label":"search","isRequired":true,"signature":["() => Promise"],"description":[],"source":{"path":"x-pack/plugins/data_enhanced/common/search/poll_search.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/poll_search.ts#L16"}},{"type":"Function","label":"cancel","isRequired":false,"signature":["(() => void) | undefined"],"description":[],"source":{"path":"x-pack/plugins/data_enhanced/common/search/poll_search.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/poll_search.ts#L17"}},{"type":"Object","label":"{ pollInterval = 1000, abortSignal }","isRequired":true,"signature":[{"pluginId":"dataEnhanced","scope":"common","docId":"kibDataEnhancedPluginApi","section":"def-common.IAsyncSearchOptions","text":"IAsyncSearchOptions"}],"description":[],"source":{"path":"x-pack/plugins/data_enhanced/common/search/poll_search.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/poll_search.ts#L18"}}],"signature":[">(search: () => Promise, cancel?: (() => void) | undefined, { pollInterval, abortSignal }?: ",{"pluginId":"dataEnhanced","scope":"common","docId":"kibDataEnhancedPluginApi","section":"def-common.IAsyncSearchOptions","text":"IAsyncSearchOptions"},") => ","Observable",""],"description":[],"label":"pollSearch","source":{"path":"x-pack/plugins/data_enhanced/common/search/poll_search.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/poll_search.ts#L15"},"returnComment":[],"initialIsOpen":false}],"interfaces":[{"id":"def-common.EqlSearchStrategyRequest","type":"Interface","label":"EqlSearchStrategyRequest","signature":[{"pluginId":"dataEnhanced","scope":"common","docId":"kibDataEnhancedPluginApi","section":"def-common.EqlSearchStrategyRequest","text":"EqlSearchStrategyRequest"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IKibanaSearchRequest","text":"IKibanaSearchRequest"},"<",{"pluginId":"dataEnhanced","scope":"common","docId":"kibDataEnhancedPluginApi","section":"def-common.EqlRequestParams","text":"EqlRequestParams"},">"],"description":[],"children":[{"id":"def-common.EqlSearchStrategyRequest.options","type":"Object","label":"options","description":[],"source":{"path":"x-pack/plugins/data_enhanced/common/search/types.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L24"},"signature":["TransportRequestOptions"," | undefined"]}],"source":{"path":"x-pack/plugins/data_enhanced/common/search/types.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L23"},"initialIsOpen":false},{"id":"def-common.IAsyncSearchOptions","type":"Interface","label":"IAsyncSearchOptions","signature":[{"pluginId":"dataEnhanced","scope":"common","docId":"kibDataEnhancedPluginApi","section":"def-common.IAsyncSearchOptions","text":"IAsyncSearchOptions"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"}],"description":[],"children":[{"id":"def-common.IAsyncSearchOptions.pollInterval","type":"number","label":"pollInterval","description":["\nThe number of milliseconds to wait between receiving a response and sending another request"],"source":{"path":"x-pack/plugins/data_enhanced/common/search/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L33"},"signature":["number | undefined"]}],"source":{"path":"x-pack/plugins/data_enhanced/common/search/types.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L29"},"initialIsOpen":false},{"id":"def-common.SearchSessionSavedObjectAttributes","type":"Interface","label":"SearchSessionSavedObjectAttributes","description":[],"children":[{"id":"def-common.SearchSessionSavedObjectAttributes.sessionId","type":"string","label":"sessionId","description":[],"source":{"path":"x-pack/plugins/data_enhanced/common/search/session/types.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L12"}},{"id":"def-common.SearchSessionSavedObjectAttributes.name","type":"string","label":"name","description":["\nUser-facing session name to be displayed in session management"],"source":{"path":"x-pack/plugins/data_enhanced/common/search/session/types.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L16"},"signature":["string | undefined"]},{"id":"def-common.SearchSessionSavedObjectAttributes.appId","type":"string","label":"appId","description":["\nApp that created the session. e.g 'discover'"],"source":{"path":"x-pack/plugins/data_enhanced/common/search/session/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L20"},"signature":["string | undefined"]},{"id":"def-common.SearchSessionSavedObjectAttributes.created","type":"string","label":"created","description":["\nCreation time of the session"],"source":{"path":"x-pack/plugins/data_enhanced/common/search/session/types.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L24"}},{"id":"def-common.SearchSessionSavedObjectAttributes.touched","type":"string","label":"touched","description":["\nLast touch time of the session"],"source":{"path":"x-pack/plugins/data_enhanced/common/search/session/types.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L28"}},{"id":"def-common.SearchSessionSavedObjectAttributes.expires","type":"string","label":"expires","description":["\nExpiration time of the session. Expiration itself is managed by Elasticsearch."],"source":{"path":"x-pack/plugins/data_enhanced/common/search/session/types.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L32"}},{"id":"def-common.SearchSessionSavedObjectAttributes.status","type":"Enum","label":"status","description":["\nstatus"],"source":{"path":"x-pack/plugins/data_enhanced/common/search/session/types.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L36"},"signature":[{"pluginId":"dataEnhanced","scope":"common","docId":"kibDataEnhancedPluginApi","section":"def-common.SearchSessionStatus","text":"SearchSessionStatus"}]},{"id":"def-common.SearchSessionSavedObjectAttributes.urlGeneratorId","type":"string","label":"urlGeneratorId","description":["\nurlGeneratorId"],"source":{"path":"x-pack/plugins/data_enhanced/common/search/session/types.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L40"},"signature":["string | undefined"]},{"id":"def-common.SearchSessionSavedObjectAttributes.initialState","type":"Object","label":"initialState","description":["\nThe application state that was used to create the session.\nShould be used, for example, to re-load an expired search session."],"source":{"path":"x-pack/plugins/data_enhanced/common/search/session/types.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L45"},"signature":["Record | undefined"]},{"id":"def-common.SearchSessionSavedObjectAttributes.restoreState","type":"Object","label":"restoreState","description":["\nApplication state that should be used to restore the session.\nFor example, relative dates are conveted to absolute ones."],"source":{"path":"x-pack/plugins/data_enhanced/common/search/session/types.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L50"},"signature":["Record | undefined"]},{"id":"def-common.SearchSessionSavedObjectAttributes.idMapping","type":"Object","label":"idMapping","description":["\nMapping of search request hashes to their corresponsing info (async search id, etc.)"],"source":{"path":"x-pack/plugins/data_enhanced/common/search/session/types.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L54"},"signature":["Record"]},{"id":"def-common.SearchSessionSavedObjectAttributes.persisted","type":"boolean","label":"persisted","description":["\nThis value is true if the session was actively stored by the user. If it is false, the session may be purged by the system."],"source":{"path":"x-pack/plugins/data_enhanced/common/search/session/types.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L59"}},{"id":"def-common.SearchSessionSavedObjectAttributes.realmType","type":"string","label":"realmType","description":["\nThe realm type/name & username uniquely identifies the user who created this search session"],"source":{"path":"x-pack/plugins/data_enhanced/common/search/session/types.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L63"},"signature":["string | undefined"]},{"id":"def-common.SearchSessionSavedObjectAttributes.realmName","type":"string","label":"realmName","description":[],"source":{"path":"x-pack/plugins/data_enhanced/common/search/session/types.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L64"},"signature":["string | undefined"]},{"id":"def-common.SearchSessionSavedObjectAttributes.username","type":"string","label":"username","description":[],"source":{"path":"x-pack/plugins/data_enhanced/common/search/session/types.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L65"},"signature":["string | undefined"]}],"source":{"path":"x-pack/plugins/data_enhanced/common/search/session/types.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L11"},"initialIsOpen":false},{"id":"def-common.SearchSessionRequestInfo","type":"Interface","label":"SearchSessionRequestInfo","description":[],"children":[{"id":"def-common.SearchSessionRequestInfo.id","type":"string","label":"id","description":["\nID of the async search request"],"source":{"path":"x-pack/plugins/data_enhanced/common/search/session/types.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L72"}},{"id":"def-common.SearchSessionRequestInfo.strategy","type":"string","label":"strategy","description":["\nSearch strategy used to submit the search request"],"source":{"path":"x-pack/plugins/data_enhanced/common/search/session/types.ts","lineNumber":76,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L76"}},{"id":"def-common.SearchSessionRequestInfo.status","type":"string","label":"status","description":["\nstatus"],"source":{"path":"x-pack/plugins/data_enhanced/common/search/session/types.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L80"}},{"id":"def-common.SearchSessionRequestInfo.error","type":"string","label":"error","description":["\nAn optional error. Set if status is set to error."],"source":{"path":"x-pack/plugins/data_enhanced/common/search/session/types.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L84"},"signature":["string | undefined"]}],"source":{"path":"x-pack/plugins/data_enhanced/common/search/session/types.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L68"},"initialIsOpen":false}],"enums":[{"id":"def-common.SearchSessionStatus","type":"Enum","label":"SearchSessionStatus","description":[],"source":{"path":"x-pack/plugins/data_enhanced/common/search/session/status.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/status.ts#L8"},"initialIsOpen":false}],"misc":[{"id":"def-common.SEARCH_SESSION_TYPE","type":"string","label":"SEARCH_SESSION_TYPE","description":[],"source":{"path":"x-pack/plugins/data_enhanced/common/search/session/types.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/session/types.ts#L10"},"signature":["\"search-session\""],"initialIsOpen":false},{"id":"def-common.ENHANCED_ES_SEARCH_STRATEGY","type":"string","label":"ENHANCED_ES_SEARCH_STRATEGY","description":[],"source":{"path":"x-pack/plugins/data_enhanced/common/search/types.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L17"},"signature":["\"ese\""],"initialIsOpen":false},{"id":"def-common.EQL_SEARCH_STRATEGY","type":"string","label":"EQL_SEARCH_STRATEGY","description":[],"source":{"path":"x-pack/plugins/data_enhanced/common/search/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L19"},"signature":["\"eql\""],"initialIsOpen":false},{"id":"def-common.EqlRequestParams","type":"Type","label":"EqlRequestParams","description":[],"source":{"path":"x-pack/plugins/data_enhanced/common/search/types.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L21"},"signature":["EqlSearch>"],"initialIsOpen":false},{"id":"def-common.EqlSearchStrategyResponse","type":"Type","label":"EqlSearchStrategyResponse","description":[],"source":{"path":"x-pack/plugins/data_enhanced/common/search/types.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/data_enhanced/common/search/types.ts#L27"},"signature":["IKibanaSearchResponse>"],"initialIsOpen":false}],"objects":[]}} \ No newline at end of file diff --git a/api_docs/data_enhanced.mdx b/api_docs/data_enhanced.mdx new file mode 100644 index 0000000000000..06cd8c8a5a084 --- /dev/null +++ b/api_docs/data_enhanced.mdx @@ -0,0 +1,34 @@ +--- +id: kibDataEnhancedPluginApi +slug: /kibana-dev-docs/dataEnhancedPluginApi +title: dataEnhanced +image: https://source.unsplash.com/400x175/?github +summary: API docs for the dataEnhanced plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'dataEnhanced'] +--- + +import dataEnhancedObj from './data_enhanced.json'; + +## Client + +### Start + +### Consts, variables and types + +## Server + +### Classes + +### Consts, variables and types + +## Common + +### Functions + +### Interfaces + +### Enums + +### Consts, variables and types + diff --git a/api_docs/data_field_formats.json b/api_docs/data_field_formats.json new file mode 100644 index 0000000000000..03fa4f63ec349 --- /dev/null +++ b/api_docs/data_field_formats.json @@ -0,0 +1 @@ +{"id":"data.fieldFormats","client":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[{"id":"def-public.baseFormattersPublic","type":"Array","label":"baseFormattersPublic","description":[],"source":{"path":"src/plugins/data/public/field_formats/constants.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/field_formats/constants.ts#L12"},"signature":["(typeof ","DateFormat"," | typeof ","DateNanosFormat"," | ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatInstanceType","text":"FieldFormatInstanceType"},")[]"],"initialIsOpen":false},{"id":"def-public.FieldFormatsStart","type":"Type","label":"FieldFormatsStart","description":[],"source":{"path":"src/plugins/data/public/field_formats/field_formats_service.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/field_formats/field_formats_service.ts#L55"},"signature":["Pick & { deserialize: FormatFactory; }"],"initialIsOpen":false}],"objects":[]},"server":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"common":{"classes":[{"id":"def-common.FieldFormatsRegistry","type":"Class","label":"FieldFormatsRegistry","description":[],"children":[{"id":"def-common.FieldFormatsRegistry.fieldFormats","type":"Object","label":"fieldFormats","description":[],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L29"},"signature":["Map"]},{"id":"def-common.FieldFormatsRegistry.defaultMap","type":"Object","children":[],"description":[],"label":"defaultMap","source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L30"}},{"id":"def-common.FieldFormatsRegistry.metaParamsOptions","type":"Object","children":[],"description":[],"label":"metaParamsOptions","source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L31"}},{"id":"def-common.FieldFormatsRegistry.getConfig","type":"Function","label":"getConfig","description":[],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L32"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.GetConfigFn","text":"GetConfigFn"}," | undefined"]},{"id":"def-common.FieldFormatsRegistry.deserialize","type":"Function","children":[{"type":"Object","label":"mapping","isRequired":false,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializedFieldFormat","text":"SerializedFieldFormat"},"> | undefined"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L34"}}],"signature":["(mapping?: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializedFieldFormat","text":"SerializedFieldFormat"},"> | undefined) => ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"}],"description":[],"label":"deserialize","source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L34"},"returnComment":[]},{"id":"def-common.FieldFormatsRegistry.init","type":"Function","label":"init","signature":["(getConfig: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.GetConfigFn","text":"GetConfigFn"},", metaParamsOptions?: Record, defaultFieldConverters?: ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatInstanceType","text":"FieldFormatInstanceType"},"[]) => void"],"description":[],"children":[{"type":"Function","label":"getConfig","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.GetConfigFn","text":"GetConfigFn"}],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L52"}},{"type":"Object","label":"metaParamsOptions","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L53"}},{"type":"Array","label":"defaultFieldConverters","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatInstanceType","text":"FieldFormatInstanceType"},"[]"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L54"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L51"}},{"id":"def-common.FieldFormatsRegistry.getDefaultConfig","type":"Function","children":[{"type":"Enum","label":"fieldType","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"}],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L72"}},{"type":"Array","label":"esTypes","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ES_FIELD_TYPES","text":"ES_FIELD_TYPES"},"[] | undefined"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L73"}}],"signature":["(fieldType: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"},", esTypes?: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ES_FIELD_TYPES","text":"ES_FIELD_TYPES"},"[] | undefined) => ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatConfig","text":"FieldFormatConfig"}],"description":["\nGet the id of the default type for this field type\nusing the format:defaultTypeMap config map\n"],"label":"getDefaultConfig","source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L71"},"returnComment":[]},{"id":"def-common.FieldFormatsRegistry.getType","type":"Function","children":[{"type":"string","label":"formatId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L88"}}],"signature":["(formatId: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatInstanceType","text":"FieldFormatInstanceType"}," | undefined"],"description":["\nGet a derived FieldFormat class by its id.\n"],"label":"getType","source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L88"},"returnComment":[]},{"id":"def-common.FieldFormatsRegistry.getTypeWithoutMetaParams","type":"Function","children":[{"type":"string","label":"formatId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L102"}}],"signature":["(formatId: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatInstanceType","text":"FieldFormatInstanceType"}," | undefined"],"description":[],"label":"getTypeWithoutMetaParams","source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L102"},"returnComment":[]},{"id":"def-common.FieldFormatsRegistry.getDefaultType","type":"Function","children":[{"type":"Enum","label":"fieldType","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"}],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L116"}},{"type":"Array","label":"esTypes","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ES_FIELD_TYPES","text":"ES_FIELD_TYPES"},"[] | undefined"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":117,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L117"}}],"signature":["(fieldType: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"},", esTypes?: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ES_FIELD_TYPES","text":"ES_FIELD_TYPES"},"[] | undefined) => ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatInstanceType","text":"FieldFormatInstanceType"}," | undefined"],"description":["\nGet the default FieldFormat type (class) for\na field type, using the format:defaultTypeMap.\nused by the field editor\n"],"label":"getDefaultType","source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L115"},"returnComment":[]},{"id":"def-common.FieldFormatsRegistry.getTypeNameByEsTypes","type":"Function","children":[{"type":"Array","label":"esTypes","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ES_FIELD_TYPES","text":"ES_FIELD_TYPES"},"[] | undefined"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L131"}}],"signature":["(esTypes: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ES_FIELD_TYPES","text":"ES_FIELD_TYPES"},"[] | undefined) => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ES_FIELD_TYPES","text":"ES_FIELD_TYPES"}," | undefined"],"description":["\nGet the name of the default type for ES types like date_nanos\nusing the format:defaultTypeMap config map\n"],"label":"getTypeNameByEsTypes","source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L131"},"returnComment":[]},{"id":"def-common.FieldFormatsRegistry.getDefaultTypeName","type":"Function","children":[{"type":"Enum","label":"fieldType","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"}],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":148,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L148"}},{"type":"Array","label":"esTypes","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ES_FIELD_TYPES","text":"ES_FIELD_TYPES"},"[] | undefined"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":149,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L149"}}],"signature":["(fieldType: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"},", esTypes?: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ES_FIELD_TYPES","text":"ES_FIELD_TYPES"},"[] | undefined) => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ES_FIELD_TYPES","text":"ES_FIELD_TYPES"}],"description":["\nGet the default FieldFormat type name for\na field type, using the format:defaultTypeMap.\n"],"label":"getDefaultTypeName","source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":147,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L147"},"returnComment":[]},{"id":"def-common.FieldFormatsRegistry.getInstance","type":"Function","label":"getInstance","description":["\nGet the singleton instance of the FieldFormat type by its id.\n"],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":162,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L162"},"signature":["((formatId: string, params?: Record) => ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"},") & _.MemoizedFunction"]},{"id":"def-common.FieldFormatsRegistry.getDefaultInstancePlain","type":"Function","children":[{"type":"Enum","label":"fieldType","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"}],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":187,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L187"}},{"type":"Array","label":"esTypes","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ES_FIELD_TYPES","text":"ES_FIELD_TYPES"},"[] | undefined"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":188,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L188"}},{"type":"Object","label":"params","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":189,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L189"}}],"signature":["(fieldType: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"},", esTypes?: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ES_FIELD_TYPES","text":"ES_FIELD_TYPES"},"[] | undefined, params?: Record) => ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"}],"description":["\nGet the default fieldFormat instance for a field format.\n"],"label":"getDefaultInstancePlain","source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":186,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L186"},"returnComment":[]},{"id":"def-common.FieldFormatsRegistry.getDefaultInstanceCacheResolver","type":"Function","label":"getDefaultInstanceCacheResolver","signature":["(fieldType: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"},", esTypes: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ES_FIELD_TYPES","text":"ES_FIELD_TYPES"},"[]) => string"],"description":["\nReturns a cache key built by the given variables for caching in memoized\nWhere esType contains fieldType, fieldType is returned\n-> kibana types have a higher priority in that case\n-> would lead to failing tests that match e.g. date format with/without esTypes\nhttps://lodash.com/docs#memoize\n"],"children":[{"type":"Enum","label":"fieldType","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"}],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":210,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L210"}},{"type":"Array","label":"esTypes","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ES_FIELD_TYPES","text":"ES_FIELD_TYPES"},"[]"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":210,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L210"}}],"tags":["return"],"returnComment":[],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":210,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L210"}},{"id":"def-common.FieldFormatsRegistry.getByFieldType","type":"Function","label":"getByFieldType","signature":["(fieldType: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatInstanceType","text":"FieldFormatInstanceType"},"[]"],"description":["\nGet filtered list of field formats by format type\n"],"children":[{"type":"Enum","label":"fieldType","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"}],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":223,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L223"}}],"tags":["return"],"returnComment":[],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":223,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L223"}},{"id":"def-common.FieldFormatsRegistry.getDefaultInstance","type":"Function","label":"getDefaultInstance","description":["\nGet the default fieldFormat instance for a field format.\nIt's a memoized function that builds and reads a cache\n"],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":242,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L242"},"signature":["((fieldType: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"},", esTypes?: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ES_FIELD_TYPES","text":"ES_FIELD_TYPES"},"[] | undefined, params?: Record) => ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"},") & _.MemoizedFunction"]},{"id":"def-common.FieldFormatsRegistry.parseDefaultTypeMap","type":"Function","label":"parseDefaultTypeMap","signature":["(value: any) => void"],"description":[],"children":[{"type":"Any","label":"value","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":244,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L244"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":244,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L244"}},{"id":"def-common.FieldFormatsRegistry.register","type":"Function","label":"register","signature":["(fieldFormats: ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatInstanceType","text":"FieldFormatInstanceType"},"[]) => void"],"description":[],"children":[{"type":"Array","label":"fieldFormats","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatInstanceType","text":"FieldFormatInstanceType"},"[]"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":255,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L255"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":255,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L255"}}],"source":{"path":"src/plugins/data/common/field_formats/field_formats_registry.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_formats_registry.ts#L28"},"initialIsOpen":false},{"id":"def-common.FieldFormat","type":"Class","label":"FieldFormat","description":[],"children":[{"id":"def-common.FieldFormat.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L32"}},{"id":"def-common.FieldFormat.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L38"}},{"id":"def-common.FieldFormat.fieldType","type":"CompoundType","label":"fieldType","description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L44"},"signature":["string | string[]"]},{"id":"def-common.FieldFormat.convertObject","type":"Object","label":"convertObject","description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L52"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatConvert","text":"FieldFormatConvert"}," | undefined"]},{"id":"def-common.FieldFormat.htmlConvert","type":"Function","label":"htmlConvert","description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L60"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.HtmlContextTypeConvert","text":"HtmlContextTypeConvert"}," | undefined"]},{"id":"def-common.FieldFormat.textConvert","type":"Function","label":"textConvert","description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L68"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.TextContextTypeConvert","text":"TextContextTypeConvert"}," | undefined"]},{"id":"def-common.FieldFormat.type","type":"Any","label":"type","description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L74"},"signature":["any"]},{"id":"def-common.FieldFormat.allowsNumericalAggregations","type":"CompoundType","label":"allowsNumericalAggregations","description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L75"},"signature":["boolean | undefined"]},{"id":"def-common.FieldFormat._params","type":"Any","label":"_params","description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L77"},"signature":["any"]},{"id":"def-common.FieldFormat.getConfig","type":"Function","label":"getConfig","description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L78"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.GetConfigFn","text":"GetConfigFn"}," | undefined"]},{"id":"def-common.FieldFormat.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"_params","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.IFieldFormatMetaParams","text":"IFieldFormatMetaParams"}],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L80"}},{"type":"Function","label":"getConfig","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.GetConfigFn","text":"GetConfigFn"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L80"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L80"}},{"id":"def-common.FieldFormat.convert","type":"Function","label":"convert","signature":["(value: any, contentType?: ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatsContentType","text":"FieldFormatsContentType"},", options?: Record | ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.HtmlContextTypeOptions","text":"HtmlContextTypeOptions"}," | undefined) => string"],"description":["\nConvert a raw value to a formatted string"],"children":[{"type":"Any","label":"value","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L99"}},{"type":"CompoundType","label":"contentType","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatsContentType","text":"FieldFormatsContentType"}],"description":["- optional content type, the only two contentTypes\ncurrently supported are \"html\" and \"text\", which helps\nformatters adjust to different contexts"],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":100,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L100"}},{"type":"CompoundType","label":"options","isRequired":false,"signature":["Record | ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.HtmlContextTypeOptions","text":"HtmlContextTypeOptions"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L101"}}],"tags":["return","public"],"returnComment":["- the formatted string, which is assumed to be html, safe for\n injecting into the DOM or a DOM attribute"],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L98"}},{"id":"def-common.FieldFormat.getConverterFor","type":"Function","label":"getConverterFor","signature":["(contentType?: ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatsContentType","text":"FieldFormatsContentType"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatConvertFunction","text":"FieldFormatConvertFunction"}],"description":["\nGet a convert function that is bound to a specific contentType"],"children":[{"type":"CompoundType","label":"contentType","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatsContentType","text":"FieldFormatsContentType"}],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":119,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L119"}}],"tags":["return","public"],"returnComment":["- a bound converter function"],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":118,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L118"}},{"id":"def-common.FieldFormat.getParamDefaults","type":"Function","label":"getParamDefaults","signature":["() => Record"],"description":["\nGet parameter defaults"],"children":[],"tags":["return","public"],"returnComment":["- parameter defaults"],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":133,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L133"}},{"id":"def-common.FieldFormat.param","type":"Function","label":"param","signature":["(name: string) => any"],"description":["\nGet the value of a param. This value may be a default value.\n"],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":["- the param name to fetch"],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":144,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L144"}}],"tags":["return","public"],"returnComment":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":144,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L144"}},{"id":"def-common.FieldFormat.params","type":"Function","label":"params","signature":["() => Record"],"description":["\nGet all of the params in a single object"],"children":[],"tags":["return","public"],"returnComment":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":161,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L161"}},{"id":"def-common.FieldFormat.toJSON","type":"Function","label":"toJSON","signature":["() => { id: any; params: any; }"],"description":["\nSerialize this format to a simple POJO, with only the params\nthat are not default\n"],"children":[],"tags":["return","public"],"returnComment":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":172,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L172"}},{"id":"def-common.FieldFormat.from","type":"Function","label":"from","signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"},".from"],"description":[],"children":[{"type":"Function","label":"convertFn","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatConvertFunction","text":"FieldFormatConvertFunction"}],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":193,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L193"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":193,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L193"}},{"id":"def-common.FieldFormat.setupContentType","type":"Function","label":"setupContentType","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatConvert","text":"FieldFormatConvert"}],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":197,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L197"}},{"id":"def-common.FieldFormat.isInstanceOfFieldFormat","type":"Function","label":"isInstanceOfFieldFormat","signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"},".isInstanceOfFieldFormat"],"description":[],"children":[{"type":"Any","label":"fieldFormat","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":204,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L204"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":204,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L204"}}],"source":{"path":"src/plugins/data/common/field_formats/field_format.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/field_format.ts#L26"},"initialIsOpen":false},{"id":"def-common.BoolFormat","type":"Class","label":"BoolFormat","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.BoolFormat","text":"BoolFormat"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"}],"children":[{"id":"def-common.BoolFormat.id","type":"Enum","label":"id","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/boolean.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/boolean.ts#L16"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FIELD_FORMAT_IDS","text":"FIELD_FORMAT_IDS"}]},{"id":"def-common.BoolFormat.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/boolean.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/boolean.ts#L17"}},{"id":"def-common.BoolFormat.fieldType","type":"Array","label":"fieldType","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/boolean.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/boolean.ts#L20"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"},"[]"]},{"id":"def-common.BoolFormat.textConvert","type":"Function","children":[{"type":"Any","label":"value","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/boolean.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/boolean.ts#L22"}}],"signature":["(value: any) => string"],"description":[],"label":"textConvert","source":{"path":"src/plugins/data/common/field_formats/converters/boolean.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/boolean.ts#L22"},"returnComment":[]}],"source":{"path":"src/plugins/data/common/field_formats/converters/boolean.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/boolean.ts#L15"},"initialIsOpen":false},{"id":"def-common.BytesFormat","type":"Class","label":"BytesFormat","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.BytesFormat","text":"BytesFormat"}," extends ","NumeralFormat"],"children":[{"id":"def-common.BytesFormat.id","type":"Enum","label":"id","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/bytes.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/bytes.ts#L14"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FIELD_FORMAT_IDS","text":"FIELD_FORMAT_IDS"}]},{"id":"def-common.BytesFormat.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/bytes.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/bytes.ts#L15"}},{"id":"def-common.BytesFormat.id","type":"Enum","label":"id","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/bytes.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/bytes.ts#L19"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FIELD_FORMAT_IDS","text":"FIELD_FORMAT_IDS"}]},{"id":"def-common.BytesFormat.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/bytes.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/bytes.ts#L20"}},{"id":"def-common.BytesFormat.allowsNumericalAggregations","type":"boolean","label":"allowsNumericalAggregations","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/bytes.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/bytes.ts#L21"}}],"source":{"path":"src/plugins/data/common/field_formats/converters/bytes.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/bytes.ts#L13"},"initialIsOpen":false},{"id":"def-common.ColorFormat","type":"Class","label":"ColorFormat","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.ColorFormat","text":"ColorFormat"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"}],"children":[{"id":"def-common.ColorFormat.id","type":"Enum","label":"id","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/color.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/color.ts#L20"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FIELD_FORMAT_IDS","text":"FIELD_FORMAT_IDS"}]},{"id":"def-common.ColorFormat.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/color.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/color.ts#L21"}},{"id":"def-common.ColorFormat.fieldType","type":"Array","label":"fieldType","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/color.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/color.ts#L24"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"},"[]"]},{"id":"def-common.ColorFormat.getParamDefaults","type":"Function","label":"getParamDefaults","signature":["() => { fieldType: null; colors: { range: string; regex: string; text: string; background: string; }[]; }"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/field_formats/converters/color.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/color.ts#L26"}},{"id":"def-common.ColorFormat.findColorRuleForVal","type":"Function","label":"findColorRuleForVal","signature":["(val: any) => any"],"description":[],"children":[{"type":"Any","label":"val","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/color.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/color.ts#L33"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/field_formats/converters/color.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/color.ts#L33"}},{"id":"def-common.ColorFormat.htmlConvert","type":"Function","children":[{"type":"Any","label":"val","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/color.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/color.ts#L52"}}],"signature":["(val: any) => string"],"description":[],"label":"htmlConvert","source":{"path":"src/plugins/data/common/field_formats/converters/color.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/color.ts#L52"},"returnComment":[]}],"source":{"path":"src/plugins/data/common/field_formats/converters/color.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/color.ts#L19"},"initialIsOpen":false},{"id":"def-common.DurationFormat","type":"Class","label":"DurationFormat","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.DurationFormat","text":"DurationFormat"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"}],"children":[{"id":"def-common.DurationFormat.id","type":"Enum","label":"id","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/duration.ts","lineNumber":158,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/duration.ts#L158"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FIELD_FORMAT_IDS","text":"FIELD_FORMAT_IDS"}]},{"id":"def-common.DurationFormat.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/duration.ts","lineNumber":159,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/duration.ts#L159"}},{"id":"def-common.DurationFormat.fieldType","type":"Enum","label":"fieldType","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/duration.ts","lineNumber":162,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/duration.ts#L162"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"}]},{"id":"def-common.DurationFormat.inputFormats","type":"Array","label":"inputFormats","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/duration.ts","lineNumber":163,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/duration.ts#L163"},"signature":["{ text: string; kind: string; }[]"]},{"id":"def-common.DurationFormat.outputFormats","type":"Array","label":"outputFormats","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/duration.ts","lineNumber":164,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/duration.ts#L164"},"signature":["{ text: string; method: string; }[]"]},{"id":"def-common.DurationFormat.allowsNumericalAggregations","type":"boolean","label":"allowsNumericalAggregations","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/duration.ts","lineNumber":165,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/duration.ts#L165"}},{"id":"def-common.DurationFormat.isHuman","type":"Function","label":"isHuman","signature":["() => boolean"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/field_formats/converters/duration.ts","lineNumber":167,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/duration.ts#L167"}},{"id":"def-common.DurationFormat.getParamDefaults","type":"Function","label":"getParamDefaults","signature":["() => { inputFormat: string; outputFormat: string; outputPrecision: number; }"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/field_formats/converters/duration.ts","lineNumber":170,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/duration.ts#L170"}},{"id":"def-common.DurationFormat.textConvert","type":"Function","children":[{"type":"Any","label":"val","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/duration.ts","lineNumber":178,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/duration.ts#L178"}}],"signature":["(val: any) => string"],"description":[],"label":"textConvert","source":{"path":"src/plugins/data/common/field_formats/converters/duration.ts","lineNumber":178,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/duration.ts#L178"},"returnComment":[]}],"source":{"path":"src/plugins/data/common/field_formats/converters/duration.ts","lineNumber":157,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/duration.ts#L157"},"initialIsOpen":false},{"id":"def-common.IpFormat","type":"Class","label":"IpFormat","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.IpFormat","text":"IpFormat"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"}],"children":[{"id":"def-common.IpFormat.id","type":"Enum","label":"id","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/ip.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/ip.ts#L15"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FIELD_FORMAT_IDS","text":"FIELD_FORMAT_IDS"}]},{"id":"def-common.IpFormat.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/ip.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/ip.ts#L16"}},{"id":"def-common.IpFormat.fieldType","type":"Enum","label":"fieldType","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/ip.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/ip.ts#L19"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"}]},{"id":"def-common.IpFormat.textConvert","type":"Function","children":[{"type":"Any","label":"val","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/ip.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/ip.ts#L21"}}],"signature":["(val: any) => any"],"description":[],"label":"textConvert","source":{"path":"src/plugins/data/common/field_formats/converters/ip.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/ip.ts#L21"},"returnComment":[]}],"source":{"path":"src/plugins/data/common/field_formats/converters/ip.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/ip.ts#L14"},"initialIsOpen":false},{"id":"def-common.NumberFormat","type":"Class","label":"NumberFormat","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.NumberFormat","text":"NumberFormat"}," extends ","NumeralFormat"],"children":[{"id":"def-common.NumberFormat.id","type":"Enum","label":"id","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/number.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/number.ts#L14"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FIELD_FORMAT_IDS","text":"FIELD_FORMAT_IDS"}]},{"id":"def-common.NumberFormat.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/number.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/number.ts#L15"}},{"id":"def-common.NumberFormat.id","type":"Enum","label":"id","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/number.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/number.ts#L19"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FIELD_FORMAT_IDS","text":"FIELD_FORMAT_IDS"}]},{"id":"def-common.NumberFormat.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/number.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/number.ts#L20"}},{"id":"def-common.NumberFormat.allowsNumericalAggregations","type":"boolean","label":"allowsNumericalAggregations","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/number.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/number.ts#L21"}}],"source":{"path":"src/plugins/data/common/field_formats/converters/number.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/number.ts#L13"},"initialIsOpen":false},{"id":"def-common.PercentFormat","type":"Class","label":"PercentFormat","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.PercentFormat","text":"PercentFormat"}," extends ","NumeralFormat"],"children":[{"id":"def-common.PercentFormat.id","type":"Enum","label":"id","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/percent.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/percent.ts#L15"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FIELD_FORMAT_IDS","text":"FIELD_FORMAT_IDS"}]},{"id":"def-common.PercentFormat.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/percent.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/percent.ts#L16"}},{"id":"def-common.PercentFormat.id","type":"Enum","label":"id","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/percent.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/percent.ts#L20"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FIELD_FORMAT_IDS","text":"FIELD_FORMAT_IDS"}]},{"id":"def-common.PercentFormat.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/percent.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/percent.ts#L21"}},{"id":"def-common.PercentFormat.allowsNumericalAggregations","type":"boolean","label":"allowsNumericalAggregations","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/percent.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/percent.ts#L22"}},{"id":"def-common.PercentFormat.getParamDefaults","type":"Function","children":[],"signature":["() => { pattern: any; fractional: boolean; }"],"description":[],"label":"getParamDefaults","source":{"path":"src/plugins/data/common/field_formats/converters/percent.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/percent.ts#L24"},"returnComment":[]},{"id":"def-common.PercentFormat.textConvert","type":"Function","children":[{"type":"Any","label":"val","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/percent.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/percent.ts#L29"}}],"signature":["(val: any) => string"],"description":[],"label":"textConvert","source":{"path":"src/plugins/data/common/field_formats/converters/percent.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/percent.ts#L29"},"returnComment":[]}],"source":{"path":"src/plugins/data/common/field_formats/converters/percent.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/percent.ts#L14"},"initialIsOpen":false},{"id":"def-common.RelativeDateFormat","type":"Class","label":"RelativeDateFormat","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.RelativeDateFormat","text":"RelativeDateFormat"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"}],"children":[{"id":"def-common.RelativeDateFormat.id","type":"Enum","label":"id","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/relative_date.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/relative_date.ts#L16"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FIELD_FORMAT_IDS","text":"FIELD_FORMAT_IDS"}]},{"id":"def-common.RelativeDateFormat.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/relative_date.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/relative_date.ts#L17"}},{"id":"def-common.RelativeDateFormat.fieldType","type":"Enum","label":"fieldType","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/relative_date.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/relative_date.ts#L20"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"}]},{"id":"def-common.RelativeDateFormat.textConvert","type":"Function","children":[{"type":"Any","label":"val","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/relative_date.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/relative_date.ts#L22"}}],"signature":["(val: any) => any"],"description":[],"label":"textConvert","source":{"path":"src/plugins/data/common/field_formats/converters/relative_date.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/relative_date.ts#L22"},"returnComment":[]}],"source":{"path":"src/plugins/data/common/field_formats/converters/relative_date.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/relative_date.ts#L15"},"initialIsOpen":false},{"id":"def-common.SourceFormat","type":"Class","label":"SourceFormat","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.SourceFormat","text":"SourceFormat"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"}],"children":[{"id":"def-common.SourceFormat.id","type":"Enum","label":"id","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/source.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/source.ts#L45"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FIELD_FORMAT_IDS","text":"FIELD_FORMAT_IDS"}]},{"id":"def-common.SourceFormat.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/source.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/source.ts#L46"}},{"id":"def-common.SourceFormat.fieldType","type":"Enum","label":"fieldType","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/source.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/source.ts#L47"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"}]},{"id":"def-common.SourceFormat.textConvert","type":"Function","children":[{"type":"Any","label":"value","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/source.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/source.ts#L49"}}],"signature":["(value: any) => string"],"description":[],"label":"textConvert","source":{"path":"src/plugins/data/common/field_formats/converters/source.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/source.ts#L49"},"returnComment":[]},{"id":"def-common.SourceFormat.htmlConvert","type":"Function","children":[{"type":"Any","label":"value","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/source.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/source.ts#L51"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.HtmlContextTypeOptions","text":"HtmlContextTypeOptions"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/source.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/source.ts#L51"}}],"signature":["(value: any, options?: ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.HtmlContextTypeOptions","text":"HtmlContextTypeOptions"}," | undefined) => string"],"description":[],"label":"htmlConvert","source":{"path":"src/plugins/data/common/field_formats/converters/source.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/source.ts#L51"},"returnComment":[]}],"source":{"path":"src/plugins/data/common/field_formats/converters/source.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/source.ts#L44"},"initialIsOpen":false},{"id":"def-common.StaticLookupFormat","type":"Class","label":"StaticLookupFormat","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.StaticLookupFormat","text":"StaticLookupFormat"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"}],"children":[{"id":"def-common.StaticLookupFormat.id","type":"Enum","label":"id","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/static_lookup.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/static_lookup.ts#L25"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FIELD_FORMAT_IDS","text":"FIELD_FORMAT_IDS"}]},{"id":"def-common.StaticLookupFormat.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/static_lookup.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/static_lookup.ts#L26"}},{"id":"def-common.StaticLookupFormat.fieldType","type":"Array","label":"fieldType","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/static_lookup.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/static_lookup.ts#L29"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"},"[]"]},{"id":"def-common.StaticLookupFormat.getParamDefaults","type":"Function","label":"getParamDefaults","signature":["() => { lookupEntries: {}[]; unknownKeyValue: null; }"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/field_formats/converters/static_lookup.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/static_lookup.ts#L36"}},{"id":"def-common.StaticLookupFormat.textConvert","type":"Function","children":[{"type":"Any","label":"val","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/static_lookup.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/static_lookup.ts#L43"}}],"signature":["(val: any) => any"],"description":[],"label":"textConvert","source":{"path":"src/plugins/data/common/field_formats/converters/static_lookup.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/static_lookup.ts#L43"},"returnComment":[]}],"source":{"path":"src/plugins/data/common/field_formats/converters/static_lookup.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/static_lookup.ts#L24"},"initialIsOpen":false},{"id":"def-common.UrlFormat","type":"Class","label":"UrlFormat","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.UrlFormat","text":"UrlFormat"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"}],"children":[{"id":"def-common.UrlFormat.id","type":"Enum","label":"id","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/url.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/url.ts#L47"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FIELD_FORMAT_IDS","text":"FIELD_FORMAT_IDS"}]},{"id":"def-common.UrlFormat.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/url.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/url.ts#L48"}},{"id":"def-common.UrlFormat.fieldType","type":"Array","label":"fieldType","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/url.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/url.ts#L51"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"},"[]"]},{"id":"def-common.UrlFormat.urlTypes","type":"Array","label":"urlTypes","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/url.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/url.ts#L61"},"signature":["{ kind: string; text: string; }[]"]},{"id":"def-common.UrlFormat.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"params","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.IFieldFormatMetaParams","text":"IFieldFormatMetaParams"}],"description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/url.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/url.ts#L63"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/field_formats/converters/url.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/url.ts#L63"}},{"id":"def-common.UrlFormat.getParamDefaults","type":"Function","label":"getParamDefaults","signature":["() => { type: string; urlTemplate: null; labelTemplate: null; width: null; height: null; }"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/field_formats/converters/url.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/url.ts#L68"}},{"id":"def-common.UrlFormat.textConvert","type":"Function","children":[{"type":"Any","label":"value","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/url.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/url.ts#L131"}}],"signature":["(value: any) => string"],"description":[],"label":"textConvert","source":{"path":"src/plugins/data/common/field_formats/converters/url.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/url.ts#L131"},"returnComment":[]},{"id":"def-common.UrlFormat.htmlConvert","type":"Function","children":[{"type":"Any","label":"rawValue","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/url.ts","lineNumber":133,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/url.ts#L133"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.HtmlContextTypeOptions","text":"HtmlContextTypeOptions"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/url.ts","lineNumber":133,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/url.ts#L133"}}],"signature":["(rawValue: any, options?: ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.HtmlContextTypeOptions","text":"HtmlContextTypeOptions"}," | undefined) => string"],"description":[],"label":"htmlConvert","source":{"path":"src/plugins/data/common/field_formats/converters/url.ts","lineNumber":133,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/url.ts#L133"},"returnComment":[]}],"source":{"path":"src/plugins/data/common/field_formats/converters/url.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/url.ts#L46"},"initialIsOpen":false},{"id":"def-common.StringFormat","type":"Class","label":"StringFormat","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.StringFormat","text":"StringFormat"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"}],"children":[{"id":"def-common.StringFormat.id","type":"Enum","label":"id","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/string.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/string.ts#L63"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FIELD_FORMAT_IDS","text":"FIELD_FORMAT_IDS"}]},{"id":"def-common.StringFormat.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/string.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/string.ts#L64"}},{"id":"def-common.StringFormat.fieldType","type":"Array","label":"fieldType","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/string.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/string.ts#L67"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"},"[]"]},{"id":"def-common.StringFormat.transformOptions","type":"Array","label":"transformOptions","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/string.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/string.ts#L80"},"signature":["({ kind: boolean; text: string; } | { kind: string; text: string; })[]"]},{"id":"def-common.StringFormat.getParamDefaults","type":"Function","label":"getParamDefaults","signature":["() => { transform: boolean; }"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/field_formats/converters/string.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/string.ts#L82"}},{"id":"def-common.StringFormat.textConvert","type":"Function","children":[{"type":"Any","label":"val","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/string.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/string.ts#L102"}}],"signature":["(val: any) => any"],"description":[],"label":"textConvert","source":{"path":"src/plugins/data/common/field_formats/converters/string.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/string.ts#L102"},"returnComment":[]}],"source":{"path":"src/plugins/data/common/field_formats/converters/string.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/string.ts#L62"},"initialIsOpen":false},{"id":"def-common.TruncateFormat","type":"Class","label":"TruncateFormat","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.TruncateFormat","text":"TruncateFormat"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"}],"children":[{"id":"def-common.TruncateFormat.id","type":"Enum","label":"id","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/truncate.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/truncate.ts#L18"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FIELD_FORMAT_IDS","text":"FIELD_FORMAT_IDS"}]},{"id":"def-common.TruncateFormat.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/truncate.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/truncate.ts#L19"}},{"id":"def-common.TruncateFormat.fieldType","type":"Enum","label":"fieldType","description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/truncate.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/truncate.ts#L22"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"}]},{"id":"def-common.TruncateFormat.textConvert","type":"Function","children":[{"type":"Any","label":"val","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/converters/truncate.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/truncate.ts#L24"}}],"signature":["(val: any) => any"],"description":[],"label":"textConvert","source":{"path":"src/plugins/data/common/field_formats/converters/truncate.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/truncate.ts#L24"},"returnComment":[]}],"source":{"path":"src/plugins/data/common/field_formats/converters/truncate.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/converters/truncate.ts#L17"},"initialIsOpen":false},{"id":"def-common.FieldFormatNotFoundError","type":"Class","label":"FieldFormatNotFoundError","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatNotFoundError","text":"FieldFormatNotFoundError"}," extends Error"],"children":[{"id":"def-common.FieldFormatNotFoundError.formatId","type":"string","label":"formatId","description":[],"source":{"path":"src/plugins/data/common/field_formats/errors.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/errors.ts#L10"}},{"id":"def-common.FieldFormatNotFoundError.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"string","label":"message","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/errors.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/errors.ts#L11"}},{"type":"string","label":"formatId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/errors.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/errors.ts#L11"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/field_formats/errors.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/errors.ts#L11"}}],"source":{"path":"src/plugins/data/common/field_formats/errors.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/errors.ts#L9"},"initialIsOpen":false}],"functions":[{"id":"def-common.getHighlightRequest","type":"Function","label":"getHighlightRequest","signature":["(query: any, shouldHighlight: boolean) => { pre_tags: string[]; post_tags: string[]; fields: { '*': {}; }; fragment_size: number; } | undefined"],"description":[],"children":[{"type":"Any","label":"query","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/utils/highlight/highlight_request.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/utils/highlight/highlight_request.ts#L13"}},{"type":"boolean","label":"shouldHighlight","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/field_formats/utils/highlight/highlight_request.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/utils/highlight/highlight_request.ts#L13"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/field_formats/utils/highlight/highlight_request.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/utils/highlight/highlight_request.ts#L13"},"initialIsOpen":false}],"interfaces":[{"id":"def-common.FieldFormatConfig","type":"Interface","label":"FieldFormatConfig","description":[],"children":[{"id":"def-common.FieldFormatConfig.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/data/common/field_formats/types.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L62"}},{"id":"def-common.FieldFormatConfig.params","type":"Object","label":"params","description":[],"source":{"path":"src/plugins/data/common/field_formats/types.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L63"},"signature":["Record"]},{"id":"def-common.FieldFormatConfig.es","type":"CompoundType","label":"es","description":[],"source":{"path":"src/plugins/data/common/field_formats/types.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L64"},"signature":["boolean | undefined"]}],"source":{"path":"src/plugins/data/common/field_formats/types.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L61"},"initialIsOpen":false}],"enums":[{"id":"def-common.FIELD_FORMAT_IDS","type":"Enum","label":"FIELD_FORMAT_IDS","description":[],"source":{"path":"src/plugins/data/common/field_formats/types.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L42"},"initialIsOpen":false}],"misc":[{"id":"def-common.IFieldFormatsRegistry","type":"Type","label":"IFieldFormatsRegistry","description":[],"source":{"path":"src/plugins/data/common/field_formats/index.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/index.ts#L11"},"signature":["{ init: (getConfig: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.GetConfigFn","text":"GetConfigFn"},", metaParamsOptions?: Record, defaultFieldConverters?: ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatInstanceType","text":"FieldFormatInstanceType"},"[]) => void; register: (fieldFormats: ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatInstanceType","text":"FieldFormatInstanceType"},"[]) => void; deserialize: ","FormatFactory","; getDefaultConfig: (fieldType: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"}],"initialIsOpen":false},{"id":"def-common.baseFormatters","type":"Array","label":"baseFormatters","description":[],"source":{"path":"src/plugins/data/common/field_formats/constants/base_formatters.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/constants/base_formatters.ts#L27"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatInstanceType","text":"FieldFormatInstanceType"},"[]"],"initialIsOpen":false},{"id":"def-common.HTML_CONTEXT_TYPE","type":"CompoundType","label":"HTML_CONTEXT_TYPE","description":[],"source":{"path":"src/plugins/data/common/field_formats/content_types/html_content_type.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/content_types/html_content_type.ts#L13"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatsContentType","text":"FieldFormatsContentType"}],"initialIsOpen":false},{"id":"def-common.TEXT_CONTEXT_TYPE","type":"CompoundType","label":"TEXT_CONTEXT_TYPE","description":[],"source":{"path":"src/plugins/data/common/field_formats/content_types/text_content_type.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/content_types/text_content_type.ts#L13"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormatsContentType","text":"FieldFormatsContentType"}],"initialIsOpen":false},{"id":"def-common.FieldFormatsGetConfigFn","type":"Type","label":"FieldFormatsGetConfigFn","description":[],"source":{"path":"src/plugins/data/common/field_formats/types.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L67"},"signature":["(key: string, defaultOverride: T | undefined) => T"],"initialIsOpen":false},{"id":"def-common.FieldFormatsContentType","type":"Type","label":"FieldFormatsContentType","description":[],"source":{"path":"src/plugins/data/common/field_formats/types.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L14"},"signature":["\"html\" | \"text\""],"initialIsOpen":false},{"id":"def-common.FieldFormatId","type":"Type","label":"FieldFormatId","description":[],"source":{"path":"src/plugins/data/common/field_formats/types.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L74"},"signature":["string"],"initialIsOpen":false},{"id":"def-common.FieldFormatInstanceType","type":"Type","label":"FieldFormatInstanceType","description":[],"source":{"path":"src/plugins/data/common/field_formats/types.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L77"},"signature":["(new (params?: any, getConfig?: GetConfigFn | undefined) => FieldFormat) & { id: FieldFormatId; title: string; fieldType: string | string[]; }"],"initialIsOpen":false},{"id":"def-common.IFieldFormat","type":"Type","label":"IFieldFormat","description":[],"source":{"path":"src/plugins/data/common/field_formats/types.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L69"},"signature":["FieldFormat"],"initialIsOpen":false},{"id":"def-common.FieldFormatsStartCommon","type":"Type","label":"FieldFormatsStartCommon","description":[],"source":{"path":"src/plugins/data/common/field_formats/types.ts","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/types.ts#L96"},"signature":["{ init: (getConfig: GetConfigFn, metaParamsOptions?: Record, defaultFieldConverters?: FieldFormatInstanceType[]) => void; register: (fieldFormats: FieldFormatInstanceType[]) => void; deserialize: ","FormatFactory","; getDefaultConfig: (fieldType: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"},", esTypes?: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ES_FIELD_TYPES","text":"ES_FIELD_TYPES"},"[] | undefined) => FieldFormatConfig; getType: (formatId: string) => FieldFormatInstanceType | undefined; getTypeWithoutMetaParams: (formatId: string) => FieldFormatInstanceType | undefined; getDefaultType: (fieldType: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"},", esTypes?: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ES_FIELD_TYPES","text":"ES_FIELD_TYPES"}],"initialIsOpen":false}],"objects":[{"id":"def-common.DEFAULT_CONVERTER_COLOR","type":"Object","children":[{"id":"def-common.DEFAULT_CONVERTER_COLOR.range","type":"string","label":"range","description":[],"source":{"path":"src/plugins/data/common/field_formats/constants/color_default.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/constants/color_default.ts#L10"}},{"id":"def-common.DEFAULT_CONVERTER_COLOR.regex","type":"string","label":"regex","description":[],"source":{"path":"src/plugins/data/common/field_formats/constants/color_default.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/constants/color_default.ts#L11"}},{"id":"def-common.DEFAULT_CONVERTER_COLOR.text","type":"string","label":"text","description":[],"source":{"path":"src/plugins/data/common/field_formats/constants/color_default.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/constants/color_default.ts#L12"}},{"id":"def-common.DEFAULT_CONVERTER_COLOR.background","type":"string","label":"background","description":[],"source":{"path":"src/plugins/data/common/field_formats/constants/color_default.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/constants/color_default.ts#L13"}}],"description":[],"label":"DEFAULT_CONVERTER_COLOR","source":{"path":"src/plugins/data/common/field_formats/constants/color_default.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/field_formats/constants/color_default.ts#L9"},"initialIsOpen":false}]}} \ No newline at end of file diff --git a/api_docs/data_field_formats.mdx b/api_docs/data_field_formats.mdx new file mode 100644 index 0000000000000..4686aff8dbfdd --- /dev/null +++ b/api_docs/data_field_formats.mdx @@ -0,0 +1,30 @@ +--- +id: kibDataFieldFormatsPluginApi +slug: /kibana-dev-docs/data.fieldFormatsPluginApi +title: data.fieldFormats +image: https://source.unsplash.com/400x175/?github +summary: API docs for the data.fieldFormats plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.fieldFormats'] +--- + +import dataFieldFormatsObj from './data_field_formats.json'; + +## Client + +### Consts, variables and types + +## Common + +### Objects + +### Functions + +### Classes + +### Interfaces + +### Enums + +### Consts, variables and types + diff --git a/api_docs/data_index_patterns.json b/api_docs/data_index_patterns.json new file mode 100644 index 0000000000000..659267fc58ed2 --- /dev/null +++ b/api_docs/data_index_patterns.json @@ -0,0 +1 @@ +{"id":"data.indexPatterns","client":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"server":{"classes":[{"id":"def-server.IndexPatternsFetcher","type":"Class","label":"IndexPatternsFetcher","description":[],"children":[{"id":"def-server.IndexPatternsFetcher.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"CompoundType","label":"elasticsearchClient","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ElasticsearchClient","text":"ElasticsearchClient"}],"description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L39"}},{"type":"boolean","label":"allowNoIndices","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L39"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L39"}},{"id":"def-server.IndexPatternsFetcher.getFieldsForWildcard","type":"Function","label":"getFieldsForWildcard","signature":["(options: { pattern: string | string[]; metaFields?: string[] | undefined; fieldCapsOptions?: { allow_no_indices: boolean; } | undefined; type?: string | undefined; rollupIndex?: string | undefined; }) => Promise<",{"pluginId":"data","scope":"server","docId":"kibDataIndexPatternsPluginApi","section":"def-server.FieldDescriptor","text":"FieldDescriptor"},"[]>"],"description":["\n Get a list of field objects for an index pattern that may contain wildcards\n"],"children":[{"id":"def-server.IndexPatternsFetcher.getFieldsForWildcard.options","type":"Object","label":"options","description":[],"children":[{"id":"def-server.IndexPatternsFetcher.getFieldsForWildcard.options.pattern","type":"CompoundType","label":"pattern","description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L54"},"signature":["string | string[]"]},{"id":"def-server.IndexPatternsFetcher.getFieldsForWildcard.options.metaFields","type":"Array","label":"metaFields","description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L55"},"signature":["string[] | undefined"]},{"id":"def-server.IndexPatternsFetcher.getFieldsForWildcard.options.fieldCapsOptions","type":"Object","label":"fieldCapsOptions","description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L56"},"signature":["{ allow_no_indices: boolean; } | undefined"]},{"id":"def-server.IndexPatternsFetcher.getFieldsForWildcard.options.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L57"},"signature":["string | undefined"]},{"id":"def-server.IndexPatternsFetcher.getFieldsForWildcard.options.rollupIndex","type":"string","label":"rollupIndex","description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L58"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L53"}}],"tags":["property","property","return"],"returnComment":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L53"}},{"id":"def-server.IndexPatternsFetcher.getFieldsForTimePattern","type":"Function","label":"getFieldsForTimePattern","signature":["(options: { pattern: string; metaFields: string[]; lookBack: number; interval: string; }) => Promise<",{"pluginId":"data","scope":"server","docId":"kibDataIndexPatternsPluginApi","section":"def-server.FieldDescriptor","text":"FieldDescriptor"},"[]>"],"description":["\n Get a list of field objects for a time pattern\n"],"children":[{"id":"def-server.IndexPatternsFetcher.getFieldsForTimePattern.options","type":"Object","label":"options","description":[],"children":[{"id":"def-server.IndexPatternsFetcher.getFieldsForTimePattern.options.pattern","type":"string","label":"pattern","description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L116"}},{"id":"def-server.IndexPatternsFetcher.getFieldsForTimePattern.options.metaFields","type":"Array","label":"metaFields","description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":117,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L117"},"signature":["string[]"]},{"id":"def-server.IndexPatternsFetcher.getFieldsForTimePattern.options.lookBack","type":"number","label":"lookBack","description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":118,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L118"}},{"id":"def-server.IndexPatternsFetcher.getFieldsForTimePattern.options.interval","type":"string","label":"interval","description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":119,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L119"}}],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L115"}}],"tags":["property","property","property","return"],"returnComment":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L115"}},{"id":"def-server.IndexPatternsFetcher.validatePatternListActive","type":"Function","label":"validatePatternListActive","signature":["(patternList: string[]) => Promise"],"description":["\n Returns an index pattern list of only those index pattern strings in the given list that return indices\n"],"children":[{"type":"Array","label":"patternList","isRequired":true,"signature":["string[]"],"description":["string[]"],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":136,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L136"}}],"tags":["return"],"returnComment":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":136,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L136"}}],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L35"},"initialIsOpen":false},{"id":"def-server.IndexPatternsServiceProvider","type":"Class","label":"IndexPatternsServiceProvider","description":[],"signature":[{"pluginId":"data","scope":"server","docId":"kibDataIndexPatternsPluginApi","section":"def-server.IndexPatternsServiceProvider","text":"IndexPatternsServiceProvider"}," implements ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.Plugin","text":"Plugin"},""],"children":[{"id":"def-server.IndexPatternsServiceProvider.setup","type":"Function","label":"setup","signature":["(core: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreSetup","text":"CoreSetup"},"<",{"pluginId":"data","scope":"server","docId":"kibDataPluginApi","section":"def-server.DataPluginStartDependencies","text":"DataPluginStartDependencies"},", ",{"pluginId":"data","scope":"server","docId":"kibDataPluginApi","section":"def-server.DataPluginStart","text":"DataPluginStart"},">, { expressions }: ",{"pluginId":"data","scope":"server","docId":"kibDataIndexPatternsPluginApi","section":"def-server.IndexPatternsServiceSetupDeps","text":"IndexPatternsServiceSetupDeps"},") => void"],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreSetup","text":"CoreSetup"},"<",{"pluginId":"data","scope":"server","docId":"kibDataPluginApi","section":"def-server.DataPluginStartDependencies","text":"DataPluginStartDependencies"},", ",{"pluginId":"data","scope":"server","docId":"kibDataPluginApi","section":"def-server.DataPluginStart","text":"DataPluginStart"},">"],"description":[],"source":{"path":"src/plugins/data/server/index_patterns/index_patterns_service.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/index_patterns_service.ts#L47"}},{"type":"Object","label":"{ expressions }","isRequired":true,"signature":[{"pluginId":"data","scope":"server","docId":"kibDataIndexPatternsPluginApi","section":"def-server.IndexPatternsServiceSetupDeps","text":"IndexPatternsServiceSetupDeps"}],"description":[],"source":{"path":"src/plugins/data/server/index_patterns/index_patterns_service.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/index_patterns_service.ts#L48"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/server/index_patterns/index_patterns_service.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/index_patterns_service.ts#L46"}},{"id":"def-server.IndexPatternsServiceProvider.start","type":"Function","label":"start","signature":["(core: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreStart","text":"CoreStart"},", { fieldFormats, logger }: ",{"pluginId":"data","scope":"server","docId":"kibDataIndexPatternsPluginApi","section":"def-server.IndexPatternsServiceStartDeps","text":"IndexPatternsServiceStartDeps"},") => { indexPatternsServiceFactory: (savedObjectsClient: Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">, elasticsearchClient: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ElasticsearchClient","text":"ElasticsearchClient"},") => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternsService","text":"IndexPatternsService"}],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreStart","text":"CoreStart"}],"description":[],"source":{"path":"src/plugins/data/server/index_patterns/index_patterns_service.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/index_patterns_service.ts#L58"}},{"type":"Object","label":"{ fieldFormats, logger }","isRequired":true,"signature":[{"pluginId":"data","scope":"server","docId":"kibDataIndexPatternsPluginApi","section":"def-server.IndexPatternsServiceStartDeps","text":"IndexPatternsServiceStartDeps"}],"description":[],"source":{"path":"src/plugins/data/server/index_patterns/index_patterns_service.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/index_patterns_service.ts#L58"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/server/index_patterns/index_patterns_service.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/index_patterns_service.ts#L58"}}],"source":{"path":"src/plugins/data/server/index_patterns/index_patterns_service.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/index_patterns_service.ts#L45"},"initialIsOpen":false}],"functions":[{"id":"def-server.shouldReadFieldFromDocValues","type":"Function","label":"shouldReadFieldFromDocValues","signature":["(aggregatable: boolean, esType: string) => boolean"],"description":[],"children":[{"type":"boolean","label":"aggregatable","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/lib/field_capabilities/should_read_field_from_doc_values.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/lib/field_capabilities/should_read_field_from_doc_values.ts#L9"}},{"type":"string","label":"esType","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/lib/field_capabilities/should_read_field_from_doc_values.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/lib/field_capabilities/should_read_field_from_doc_values.ts#L9"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/lib/field_capabilities/should_read_field_from_doc_values.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/lib/field_capabilities/should_read_field_from_doc_values.ts#L9"},"initialIsOpen":false},{"id":"def-server.mergeCapabilitiesWithFields","type":"Function","children":[{"id":"def-server.mergeCapabilitiesWithFields.rollupIndexCapabilities","type":"Object","label":"rollupIndexCapabilities","description":[],"children":[{"id":"def-server.mergeCapabilitiesWithFields.rollupIndexCapabilities.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts#L14"},"signature":["any"]}],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts#L14"}},{"id":"def-server.mergeCapabilitiesWithFields.fieldsFromFieldCapsApi","type":"Object","label":"fieldsFromFieldCapsApi","description":[],"children":[{"id":"def-server.mergeCapabilitiesWithFields.fieldsFromFieldCapsApi.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts#L15"},"signature":["any"]}],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts#L15"}},{"type":"Array","label":"previousFields","isRequired":true,"signature":[{"pluginId":"data","scope":"server","docId":"kibDataIndexPatternsPluginApi","section":"def-server.FieldDescriptor","text":"FieldDescriptor"},"[]"],"description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts#L16"}}],"signature":["(rollupIndexCapabilities: { [key: string]: any; }, fieldsFromFieldCapsApi: { [key: string]: any; }, previousFields?: ",{"pluginId":"data","scope":"server","docId":"kibDataIndexPatternsPluginApi","section":"def-server.FieldDescriptor","text":"FieldDescriptor"},"[]) => ",{"pluginId":"data","scope":"server","docId":"kibDataIndexPatternsPluginApi","section":"def-server.FieldDescriptor","text":"FieldDescriptor"},"[]"],"description":[],"label":"mergeCapabilitiesWithFields","source":{"path":"src/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/lib/merge_capabilities_with_fields.ts#L13"},"returnComment":[],"initialIsOpen":false},{"id":"def-server.getCapabilitiesForRollupIndices","type":"Function","label":"getCapabilitiesForRollupIndices","signature":["(indices: { [key: string]: any; }) => { [key: string]: any; }"],"description":[],"children":[{"id":"def-server.getCapabilitiesForRollupIndices.indices","type":"Object","label":"indices","description":[],"children":[{"id":"def-server.getCapabilitiesForRollupIndices.indices.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/lib/map_capabilities.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/lib/map_capabilities.ts#L11"},"signature":["any"]}],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/lib/map_capabilities.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/lib/map_capabilities.ts#L11"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/lib/map_capabilities.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/lib/map_capabilities.ts#L11"},"initialIsOpen":false}],"interfaces":[{"id":"def-server.FieldDescriptor","type":"Interface","label":"FieldDescriptor","description":[],"children":[{"id":"def-server.FieldDescriptor.aggregatable","type":"boolean","label":"aggregatable","description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L21"}},{"id":"def-server.FieldDescriptor.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L22"}},{"id":"def-server.FieldDescriptor.readFromDocValues","type":"boolean","label":"readFromDocValues","description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L23"}},{"id":"def-server.FieldDescriptor.searchable","type":"boolean","label":"searchable","description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L24"}},{"id":"def-server.FieldDescriptor.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L25"}},{"id":"def-server.FieldDescriptor.esTypes","type":"Array","label":"esTypes","description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L26"},"signature":["string[]"]},{"id":"def-server.FieldDescriptor.subType","type":"Object","label":"subType","description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L27"},"signature":["FieldSubType | undefined"]}],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L20"},"initialIsOpen":false},{"id":"def-server.FieldDescriptor","type":"Interface","label":"FieldDescriptor","description":[],"children":[{"id":"def-server.FieldDescriptor.aggregatable","type":"boolean","label":"aggregatable","description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L21"}},{"id":"def-server.FieldDescriptor.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L22"}},{"id":"def-server.FieldDescriptor.readFromDocValues","type":"boolean","label":"readFromDocValues","description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L23"}},{"id":"def-server.FieldDescriptor.searchable","type":"boolean","label":"searchable","description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L24"}},{"id":"def-server.FieldDescriptor.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L25"}},{"id":"def-server.FieldDescriptor.esTypes","type":"Array","label":"esTypes","description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L26"},"signature":["string[]"]},{"id":"def-server.FieldDescriptor.subType","type":"Object","label":"subType","description":[],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L27"},"signature":["FieldSubType | undefined"]}],"source":{"path":"src/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/index_patterns/fetcher/index_patterns_fetcher.ts#L20"},"initialIsOpen":false}],"enums":[],"misc":[],"objects":[]},"common":{"classes":[{"id":"def-common.IndexPatternsService","type":"Class","label":"IndexPatternsService","description":[],"children":[{"id":"def-common.IndexPatternsService.ensureDefaultIndexPattern","type":"Function","label":"ensureDefaultIndexPattern","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L67"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.EnsureDefaultIndexPattern","text":"EnsureDefaultIndexPattern"}]},{"id":"def-common.IndexPatternsService.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"{\n uiSettings,\n savedObjectsClient,\n apiClient,\n fieldFormats,\n onNotification,\n onError,\n onRedirectNoIndexPattern = () => {},\n }","isRequired":true,"signature":["IndexPatternsServiceDeps"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L69"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L69"}},{"id":"def-common.IndexPatternsService.getIds","type":"Function","children":[{"type":"boolean","label":"refresh","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L108"}}],"signature":["(refresh?: boolean) => Promise"],"description":["\nGet list of index pattern ids"],"label":"getIds","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L108"},"returnComment":[]},{"id":"def-common.IndexPatternsService.getTitles","type":"Function","children":[{"type":"boolean","label":"refresh","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":122,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L122"}}],"signature":["(refresh?: boolean) => Promise"],"description":["\nGet list of index pattern titles"],"label":"getTitles","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":122,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L122"},"returnComment":[]},{"id":"def-common.IndexPatternsService.find","type":"Function","children":[{"type":"string","label":"search","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":138,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L138"}},{"type":"number","label":"size","isRequired":true,"signature":["number"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":138,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L138"}}],"signature":["(search: string, size?: number) => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},"[]>"],"description":["\nFind and load index patterns by title"],"label":"find","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":138,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L138"},"returnComment":["IndexPattern[]"]},{"id":"def-common.IndexPatternsService.getIdsWithTitle","type":"Function","children":[{"type":"boolean","label":"refresh","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":157,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L157"}}],"signature":["(refresh?: boolean) => Promise<{ id: string; title: string; }[]>"],"description":["\nGet list of index pattern ids with titles"],"label":"getIdsWithTitle","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":156,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L156"},"returnComment":[]},{"id":"def-common.IndexPatternsService.clearCache","type":"Function","children":[{"type":"string","label":"id","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":175,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L175"}}],"signature":["(id?: string | undefined) => void"],"description":["\nClear index pattern list cache"],"label":"clearCache","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":175,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L175"},"returnComment":[]},{"id":"def-common.IndexPatternsService.getCache","type":"Function","children":[],"signature":["() => Promise<",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},"<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSavedObjectAttrs","text":"IndexPatternSavedObjectAttrs"},">[] | null | undefined>"],"description":[],"label":"getCache","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":184,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L184"},"returnComment":[]},{"id":"def-common.IndexPatternsService.getDefault","type":"Function","children":[],"signature":["() => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}," | null>"],"description":["\nGet default index pattern"],"label":"getDefault","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":194,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L194"},"returnComment":[]},{"id":"def-common.IndexPatternsService.setDefault","type":"Function","children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":208,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L208"}},{"type":"boolean","label":"force","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":208,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L208"}}],"signature":["(id: string, force?: boolean) => Promise"],"description":["\nOptionally set default index pattern, unless force = true"],"label":"setDefault","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":208,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L208"},"returnComment":[]},{"id":"def-common.IndexPatternsService.getFieldsForWildcard","type":"Function","children":[{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.GetFieldsOptions","text":"GetFieldsOptions"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":219,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L219"}}],"signature":["(options: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.GetFieldsOptions","text":"GetFieldsOptions"},") => Promise"],"description":["\nGet field list by providing { pattern }"],"label":"getFieldsForWildcard","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":219,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L219"},"returnComment":["FieldSpec[]"]},{"id":"def-common.IndexPatternsService.getFieldsForIndexPattern","type":"Function","children":[{"type":"CompoundType","label":"indexPattern","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":236,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L236"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.GetFieldsOptions","text":"GetFieldsOptions"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":237,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L237"}}],"signature":["(indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"},", options?: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.GetFieldsOptions","text":"GetFieldsOptions"}," | undefined) => Promise"],"description":["\nGet field list by providing an index patttern (or spec)"],"label":"getFieldsForIndexPattern","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":235,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L235"},"returnComment":["FieldSpec[]"]},{"id":"def-common.IndexPatternsService.refreshFields","type":"Function","children":[{"type":"Object","label":"indexPattern","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":250,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L250"}}],"signature":["(indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},") => Promise"],"description":["\nRefresh field list for a given index pattern"],"label":"refreshFields","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":250,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L250"},"returnComment":[]},{"id":"def-common.IndexPatternsService.fieldArrayToMap","type":"Function","children":[{"type":"Array","label":"fields","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},"[]"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":327,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L327"}},{"type":"Object","label":"fieldAttrs","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldAttrs","text":"FieldAttrs"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":327,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L327"}}],"signature":["(fields: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},"[], fieldAttrs?: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldAttrs","text":"FieldAttrs"}," | undefined) => Record"],"description":["\nConverts field array to map"],"label":"fieldArrayToMap","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":327,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L327"},"returnComment":["Record"]},{"id":"def-common.IndexPatternsService.savedObjectToSpec","type":"Function","children":[{"type":"Object","label":"savedObject","isRequired":true,"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},"<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternAttributes","text":"IndexPatternAttributes"},">"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":343,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L343"}}],"signature":["(savedObject: ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},"<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternAttributes","text":"IndexPatternAttributes"},">) => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"}],"description":["\nConverts index pattern saved object to index pattern spec"],"label":"savedObjectToSpec","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":343,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L343"},"returnComment":["IndexPatternSpec"]},{"id":"def-common.IndexPatternsService.get","type":"Function","children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":464,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L464"}}],"signature":["(id: string) => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},">"],"description":["\nGet an index pattern by id. Cache optimized"],"label":"get","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":464,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L464"},"returnComment":[]},{"id":"def-common.IndexPatternsService.create","type":"Function","label":"create","signature":["(spec: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"},", skipFetchFields?: boolean) => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},">"],"description":["\nCreate a new index pattern instance"],"children":[{"type":"Object","label":"spec","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":483,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L483"}},{"type":"boolean","label":"skipFetchFields","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":483,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L483"}}],"tags":[],"returnComment":["IndexPattern"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":483,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L483"}},{"id":"def-common.IndexPatternsService.createAndSave","type":"Function","label":"createAndSave","signature":["(spec: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"},", override?: boolean, skipFetchFields?: boolean) => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},">"],"description":["\nCreate a new index pattern and save it right away"],"children":[{"type":"Object","label":"spec","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":508,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508"}},{"type":"boolean","label":"override","isRequired":true,"signature":["boolean"],"description":["Overwrite if existing index pattern exists."],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":508,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508"}},{"type":"boolean","label":"skipFetchFields","isRequired":true,"signature":["boolean"],"description":["Whether to skip field refresh step."],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":508,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":508,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L508"}},{"id":"def-common.IndexPatternsService.createSavedObject","type":"Function","label":"createSavedObject","signature":["(indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},", override?: boolean) => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},">"],"description":["\nSave a new index pattern"],"children":[{"type":"Object","label":"indexPattern","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":521,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L521"}},{"type":"boolean","label":"override","isRequired":true,"signature":["boolean"],"description":["Overwrite if existing index pattern exists"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":521,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L521"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":521,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L521"}},{"id":"def-common.IndexPatternsService.updateSavedObject","type":"Function","label":"updateSavedObject","signature":["(indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},", saveAttempts?: number, ignoreErrors?: boolean) => Promise"],"description":["\nSave existing index pattern. Will attempt to merge differences if there are conflicts"],"children":[{"type":"Object","label":"indexPattern","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":547,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L547"}},{"type":"number","label":"saveAttempts","isRequired":true,"signature":["number"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":548,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L548"}},{"type":"boolean","label":"ignoreErrors","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":549,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L549"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":546,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L546"}},{"id":"def-common.IndexPatternsService.delete","type":"Function","label":"delete","signature":["(indexPatternId: string) => Promise<{}>"],"description":["\nDeletes an index pattern from .kibana index"],"children":[{"type":"string","label":"indexPatternId","isRequired":true,"signature":["string"],"description":[": Id of kibana Index Pattern to delete"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":632,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L632"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":632,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L632"}}],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L57"},"initialIsOpen":false},{"id":"def-common.IndexPattern","type":"Class","label":"IndexPattern","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}," implements ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"}],"children":[{"id":"def-common.IndexPattern.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L45"},"signature":["string | undefined"]},{"id":"def-common.IndexPattern.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L46"}},{"id":"def-common.IndexPattern.fieldFormatMap","type":"Object","label":"fieldFormatMap","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L47"},"signature":["Record"]},{"id":"def-common.IndexPattern.typeMeta","type":"Object","label":"typeMeta","description":["\nOnly used by rollup indices, used by rollup specific endpoint to load field list"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L51"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.TypeMeta","text":"TypeMeta"}," | undefined"]},{"id":"def-common.IndexPattern.fields","type":"CompoundType","label":"fields","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L52"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPatternFieldList","text":"IIndexPatternFieldList"}," & { toSpec: () => Record; }"]},{"id":"def-common.IndexPattern.timeFieldName","type":"string","label":"timeFieldName","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L53"},"signature":["string | undefined"]},{"id":"def-common.IndexPattern.intervalName","type":"string","label":"intervalName","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L58"},"signature":["string | undefined"]},{"id":"def-common.IndexPattern.type","type":"string","label":"type","description":["\nType is used to identify rollup index patterns"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L62"},"signature":["string | undefined"]},{"id":"def-common.IndexPattern.formatHit","type":"Function","label":"formatHit","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L63"},"signature":["{ (hit: Record, type?: string | undefined): any; formatField: FormatFieldFn; }"]},{"id":"def-common.IndexPattern.formatField","type":"Function","label":"formatField","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L67"},"signature":["FormatFieldFn"]},{"id":"def-common.IndexPattern.flattenHit","type":"Function","label":"flattenHit","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L68"},"signature":["(hit: Record, deep?: boolean | undefined) => Record"]},{"id":"def-common.IndexPattern.metaFields","type":"Array","label":"metaFields","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L69"},"signature":["string[]"]},{"id":"def-common.IndexPattern.version","type":"string","label":"version","description":["\nSavedObject version"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L73"},"signature":["string | undefined"]},{"id":"def-common.IndexPattern.sourceFilters","type":"Array","label":"sourceFilters","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L74"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.SourceFilter","text":"SourceFilter"},"[] | undefined"]},{"id":"def-common.IndexPattern.allowNoIndex","type":"boolean","label":"allowNoIndex","description":["\nprevents errors when index pattern exists before indices"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L84"}},{"id":"def-common.IndexPattern.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"{\n spec = {},\n fieldFormats,\n shortDotsEnable = false,\n metaFields = [],\n }","isRequired":true,"signature":["IndexPatternDeps"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L86"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L86"}},{"id":"def-common.IndexPattern.getOriginalSavedObjectBody","type":"Function","children":[],"signature":["() => { fieldAttrs?: string | undefined; title?: string | undefined; timeFieldName?: string | undefined; intervalName?: string | undefined; fields?: string | undefined; sourceFilters?: string | undefined; fieldFormatMap?: string | undefined; typeMeta?: string | undefined; type?: string | undefined; }"],"description":["\nGet last saved saved object fields"],"label":"getOriginalSavedObjectBody","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":128,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L128"},"returnComment":[]},{"id":"def-common.IndexPattern.resetOriginalSavedObjectBody","type":"Function","children":[],"signature":["() => void"],"description":["\nReset last saved saved object fields. used after saving"],"label":"resetOriginalSavedObjectBody","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":133,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L133"},"returnComment":[]},{"id":"def-common.IndexPattern.getFieldAttrs","type":"Function","children":[],"signature":["() => { [x: string]: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldAttrSet","text":"FieldAttrSet"},"; }"],"description":[],"label":"getFieldAttrs","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":137,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L137"},"returnComment":[]},{"id":"def-common.IndexPattern.getComputedFields","type":"Function","label":"getComputedFields","signature":["() => { storedFields: string[]; scriptFields: any; docvalueFields: { field: any; format: string; }[]; runtimeFields: Record; }"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":162,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L162"}},{"id":"def-common.IndexPattern.toSpec","type":"Function","label":"toSpec","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"}],"description":["\nCreate static representation of index pattern"],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":208,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L208"}},{"id":"def-common.IndexPattern.getSourceFiltering","type":"Function","label":"getSourceFiltering","signature":["() => { excludes: any[]; }"],"description":["\nGet the source filtering configuration for that index."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":230,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L230"}},{"id":"def-common.IndexPattern.addScriptedField","type":"Function","label":"addScriptedField","signature":["(name: string, script: string, fieldType?: string) => Promise"],"description":["\nAdd scripted field to field list\n"],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":["field name"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":244,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L244"}},{"type":"string","label":"script","isRequired":true,"signature":["string"],"description":["script code"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":244,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L244"}},{"type":"string","label":"fieldType","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":244,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L244"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":244,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L244"}},{"id":"def-common.IndexPattern.removeScriptedField","type":"Function","label":"removeScriptedField","signature":["(fieldName: string) => void"],"description":["\nRemove scripted field from field list"],"children":[{"type":"string","label":"fieldName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":270,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L270"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":270,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L270"}},{"id":"def-common.IndexPattern.getNonScriptedFields","type":"Function","label":"getNonScriptedFields","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":277,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L277"}},{"id":"def-common.IndexPattern.getScriptedFields","type":"Function","label":"getScriptedFields","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":281,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L281"}},{"id":"def-common.IndexPattern.isTimeBased","type":"Function","label":"isTimeBased","signature":["() => boolean"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":285,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L285"}},{"id":"def-common.IndexPattern.isTimeNanosBased","type":"Function","label":"isTimeNanosBased","signature":["() => boolean"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":289,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L289"}},{"id":"def-common.IndexPattern.getTimeField","type":"Function","label":"getTimeField","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"}," | undefined"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":294,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L294"}},{"id":"def-common.IndexPattern.getFieldByName","type":"Function","label":"getFieldByName","signature":["(name: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"}," | undefined"],"description":[],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":299,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L299"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":299,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L299"}},{"id":"def-common.IndexPattern.getAggregationRestrictions","type":"Function","label":"getAggregationRestrictions","signature":["() => Record> | undefined"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":304,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L304"}},{"id":"def-common.IndexPattern.getAsSavedObjectBody","type":"Function","label":"getAsSavedObjectBody","signature":["() => { fieldAttrs: string | undefined; title: string; timeFieldName: string | undefined; intervalName: string | undefined; sourceFilters: string | undefined; fields: string | undefined; fieldFormatMap: string | undefined; type: string | undefined; typeMeta: string | undefined; allowNoIndex: true | undefined; runtimeFieldMap: string | undefined; }"],"description":["\nReturns index pattern as saved object body for saving"],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":311,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L311"}},{"id":"def-common.IndexPattern.getFormatterForField","type":"Function","label":"getFormatterForField","signature":["(field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"}],"description":["\nProvide a field, get its formatter"],"children":[{"type":"CompoundType","label":"field","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":340,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L340"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":339,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L339"}},{"id":"def-common.IndexPattern.addRuntimeField","type":"Function","label":"addRuntimeField","signature":["(name: string, runtimeField: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.RuntimeField","text":"RuntimeField"},") => void"],"description":["\nAdd a runtime field - Appended to existing mapped field or a new field is\ncreated as appropriate"],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":["Field name"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":360,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L360"}},{"type":"Object","label":"runtimeField","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.RuntimeField","text":"RuntimeField"}],"description":["Runtime field definition"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":360,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L360"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":360,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L360"}},{"id":"def-common.IndexPattern.removeRuntimeField","type":"Function","label":"removeRuntimeField","signature":["(name: string) => void"],"description":["\nRemove a runtime field - removed from mapped field or removed unmapped\nfield as appropriate"],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":["Field name"],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":384,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L384"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":384,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L384"}},{"id":"def-common.IndexPattern.getFormatterForFieldNoDefault","type":"Function","label":"getFormatterForFieldNoDefault","signature":["(fieldname: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"}," | undefined"],"description":["\nGet formatter for a given field name. Return undefined if none exists"],"children":[{"type":"string","label":"fieldname","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":404,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L404"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":404,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L404"}},{"id":"def-common.IndexPattern.setFieldAttrs","type":"Function","label":"setFieldAttrs","signature":["(fieldName: string, attrName: K, value: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldAttrSet","text":"FieldAttrSet"},"[K]) => void"],"description":[],"children":[{"type":"string","label":"fieldName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":412,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L412"}},{"type":"Uncategorized","label":"attrName","isRequired":true,"signature":["K"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":413,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L413"}},{"type":"Uncategorized","label":"value","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldAttrSet","text":"FieldAttrSet"},"[K]"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":414,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L414"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":411,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L411"}},{"id":"def-common.IndexPattern.setFieldCustomLabel","type":"Function","label":"setFieldCustomLabel","signature":["(fieldName: string, customLabel: string | null | undefined) => void"],"description":[],"children":[{"type":"string","label":"fieldName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":422,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L422"}},{"type":"CompoundType","label":"customLabel","isRequired":false,"signature":["string | null | undefined"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":422,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L422"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":422,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L422"}},{"id":"def-common.IndexPattern.setFieldCount","type":"Function","label":"setFieldCount","signature":["(fieldName: string, count: number | null | undefined) => void"],"description":[],"children":[{"type":"string","label":"fieldName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":433,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L433"}},{"type":"CompoundType","label":"count","isRequired":false,"signature":["number | null | undefined"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":433,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L433"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":433,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L433"}},{"id":"def-common.IndexPattern.setFieldFormat","type":"Function","children":[{"type":"string","label":"fieldName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":446,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L446"}},{"type":"Object","label":"format","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializedFieldFormat","text":"SerializedFieldFormat"},">"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":446,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L446"}}],"signature":["(fieldName: string, format: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializedFieldFormat","text":"SerializedFieldFormat"},">) => void"],"description":[],"label":"setFieldFormat","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":446,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L446"},"returnComment":[]},{"id":"def-common.IndexPattern.deleteFieldFormat","type":"Function","children":[{"type":"string","label":"fieldName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":450,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L450"}}],"signature":["(fieldName: string) => void"],"description":[],"label":"deleteFieldFormat","source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":450,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L450"},"returnComment":[]}],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_pattern.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_pattern.ts#L44"},"initialIsOpen":false},{"id":"def-common.IndexPatternField","type":"Class","label":"IndexPatternField","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"}," implements ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}],"children":[{"id":"def-common.IndexPatternField.spec","type":"Object","label":"spec","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L17"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"}]},{"id":"def-common.IndexPatternField.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"spec","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L21"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L21"}},{"id":"def-common.IndexPatternField.count","type":"number","label":"count","description":["\nCount is used for field popularity"],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L31"}},{"id":"def-common.IndexPatternField.count","type":"number","label":"count","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L35"}},{"id":"def-common.IndexPatternField.runtimeField","type":"Object","label":"runtimeField","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L39"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.RuntimeField","text":"RuntimeField"}," | undefined"]},{"id":"def-common.IndexPatternField.runtimeField","type":"Object","label":"runtimeField","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L43"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.RuntimeField","text":"RuntimeField"}," | undefined"]},{"id":"def-common.IndexPatternField.script","type":"string","label":"script","description":["\nScript field code"],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L50"},"signature":["string | undefined"]},{"id":"def-common.IndexPatternField.script","type":"string","label":"script","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L54"},"signature":["string | undefined"]},{"id":"def-common.IndexPatternField.lang","type":"string","label":"lang","description":["\nScript field language"],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L61"},"signature":["string | undefined"]},{"id":"def-common.IndexPatternField.lang","type":"string","label":"lang","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L65"},"signature":["string | undefined"]},{"id":"def-common.IndexPatternField.customLabel","type":"string","label":"customLabel","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L69"},"signature":["string | undefined"]},{"id":"def-common.IndexPatternField.customLabel","type":"string","label":"customLabel","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L73"},"signature":["string | undefined"]},{"id":"def-common.IndexPatternField.conflictDescriptions","type":"Object","label":"conflictDescriptions","description":["\nDescription of field type conflicts across different indices in the same index pattern"],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L80"},"signature":["Record | undefined"]},{"id":"def-common.IndexPatternField.conflictDescriptions","type":"Object","label":"conflictDescriptions","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L84"},"signature":["Record | undefined"]},{"id":"def-common.IndexPatternField.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L89"}},{"id":"def-common.IndexPatternField.displayName","type":"string","label":"displayName","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":93,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L93"}},{"id":"def-common.IndexPatternField.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L101"}},{"id":"def-common.IndexPatternField.esTypes","type":"Array","label":"esTypes","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":107,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L107"},"signature":["string[] | undefined"]},{"id":"def-common.IndexPatternField.scripted","type":"boolean","label":"scripted","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":111,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L111"}},{"id":"def-common.IndexPatternField.searchable","type":"boolean","label":"searchable","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L115"}},{"id":"def-common.IndexPatternField.aggregatable","type":"boolean","label":"aggregatable","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":119,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L119"}},{"id":"def-common.IndexPatternField.readFromDocValues","type":"boolean","label":"readFromDocValues","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":123,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L123"}},{"id":"def-common.IndexPatternField.subType","type":"Object","label":"subType","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":127,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L127"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldSubType","text":"IFieldSubType"}," | undefined"]},{"id":"def-common.IndexPatternField.isMapped","type":"CompoundType","label":"isMapped","description":["\nIs the field part of the index mapping?"],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":134,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L134"},"signature":["boolean | undefined"]},{"id":"def-common.IndexPatternField.sortable","type":"boolean","label":"sortable","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":139,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L139"}},{"id":"def-common.IndexPatternField.filterable","type":"boolean","label":"filterable","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":146,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L146"}},{"id":"def-common.IndexPatternField.visualizable","type":"boolean","label":"visualizable","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":154,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L154"}},{"id":"def-common.IndexPatternField.deleteCount","type":"Function","label":"deleteCount","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":159,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L159"}},{"id":"def-common.IndexPatternField.toJSON","type":"Function","label":"toJSON","signature":["() => { count: number; script: string | undefined; lang: string | undefined; conflictDescriptions: Record | undefined; name: string; type: string; esTypes: string[] | undefined; scripted: boolean; searchable: boolean; aggregatable: boolean; readFromDocValues: boolean; subType: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldSubType","text":"IFieldSubType"}," | undefined; customLabel: string | undefined; }"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":163,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L163"}},{"id":"def-common.IndexPatternField.toSpec","type":"Function","label":"toSpec","signature":["({ getFormatterForField, }?: { getFormatterForField?: ((field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"},") | undefined; }) => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"}],"description":[],"children":[{"id":"def-common.IndexPatternField.toSpec.{\n- getFormatterForField,\n }","type":"Object","label":"{\n getFormatterForField,\n }","description":[],"children":[{"id":"def-common.IndexPatternField.toSpec.{\n- getFormatterForField,\n }.getFormatterForField","type":"Function","label":"getFormatterForField","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":184,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L184"},"signature":["((field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"},") | undefined"]}],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":183,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L183"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":181,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L181"}}],"source":{"path":"src/plugins/data/common/index_patterns/fields/index_pattern_field.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/index_pattern_field.ts#L16"},"initialIsOpen":false},{"id":"def-common.DuplicateIndexPatternError","type":"Class","label":"DuplicateIndexPatternError","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.DuplicateIndexPatternError","text":"DuplicateIndexPatternError"}," extends Error"],"children":[{"id":"def-common.DuplicateIndexPatternError.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"string","label":"message","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts#L10"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts#L10"}}],"source":{"path":"src/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/errors/duplicate_index_pattern.ts#L9"},"initialIsOpen":false}],"functions":[{"id":"def-common.isFilterable","type":"Function","label":"isFilterable","signature":["(field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"},") => boolean"],"description":[],"children":[{"type":"Object","label":"field","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/utils.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/utils.ts#L14"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/utils.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/utils.ts#L14"},"initialIsOpen":false},{"id":"def-common.isNestedField","type":"Function","label":"isNestedField","signature":["(field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"},") => boolean"],"description":[],"children":[{"type":"Object","label":"field","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/utils.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/utils.ts#L22"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/utils.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/utils.ts#L22"},"initialIsOpen":false},{"id":"def-common.fieldList","type":"Function","children":[{"type":"Array","label":"specs","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},"[]"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L35"}},{"type":"boolean","label":"shortDotsEnable","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L36"}}],"signature":["(specs?: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},"[], shortDotsEnable?: boolean) => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPatternFieldList","text":"IIndexPatternFieldList"}],"description":[],"label":"fieldList","source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L34"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getIndexPatternLoadMeta","type":"Function","children":[],"signature":["() => Pick<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternLoadExpressionFunctionDefinition","text":"IndexPatternLoadExpressionFunctionDefinition"},", \"type\" | \"telemetry\" | \"extract\" | \"inject\" | \"migrations\" | \"name\" | \"disabled\" | \"help\" | \"inputTypes\" | \"args\" | \"aliases\" | \"context\">"],"description":[],"label":"getIndexPatternLoadMeta","source":{"path":"src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/expressions/load_index_pattern.ts#L41"},"returnComment":[],"initialIsOpen":false}],"interfaces":[{"id":"def-common.IndexPatternAttributes","type":"Interface","label":"IndexPatternAttributes","description":["\nInterface for an index pattern saved object"],"children":[{"id":"def-common.IndexPatternAttributes.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L54"}},{"id":"def-common.IndexPatternAttributes.fields","type":"string","label":"fields","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L55"}},{"id":"def-common.IndexPatternAttributes.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L56"}},{"id":"def-common.IndexPatternAttributes.typeMeta","type":"string","label":"typeMeta","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L57"}},{"id":"def-common.IndexPatternAttributes.timeFieldName","type":"string","label":"timeFieldName","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L58"},"signature":["string | undefined"]},{"id":"def-common.IndexPatternAttributes.intervalName","type":"string","label":"intervalName","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L59"},"signature":["string | undefined"]},{"id":"def-common.IndexPatternAttributes.sourceFilters","type":"string","label":"sourceFilters","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L60"},"signature":["string | undefined"]},{"id":"def-common.IndexPatternAttributes.fieldFormatMap","type":"string","label":"fieldFormatMap","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L61"},"signature":["string | undefined"]},{"id":"def-common.IndexPatternAttributes.fieldAttrs","type":"string","label":"fieldAttrs","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L62"},"signature":["string | undefined"]},{"id":"def-common.IndexPatternAttributes.runtimeFieldMap","type":"string","label":"runtimeFieldMap","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L63"},"signature":["string | undefined"]},{"id":"def-common.IndexPatternAttributes.allowNoIndex","type":"CompoundType","label":"allowNoIndex","description":["\nprevents errors when index pattern exists before indices"],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L67"},"signature":["boolean | undefined"]}],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L53"},"initialIsOpen":false},{"id":"def-common.IFieldType","type":"Interface","label":"IFieldType","description":[],"children":[{"id":"def-common.IFieldType.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L12"}},{"id":"def-common.IFieldType.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L13"}},{"id":"def-common.IFieldType.script","type":"string","label":"script","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L14"},"signature":["string | undefined"]},{"id":"def-common.IFieldType.lang","type":"string","label":"lang","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L15"},"signature":["string | undefined"]},{"id":"def-common.IFieldType.count","type":"number","label":"count","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L16"},"signature":["number | undefined"]},{"id":"def-common.IFieldType.esTypes","type":"Array","label":"esTypes","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L19"},"signature":["string[] | undefined"]},{"id":"def-common.IFieldType.aggregatable","type":"CompoundType","label":"aggregatable","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L20"},"signature":["boolean | undefined"]},{"id":"def-common.IFieldType.filterable","type":"CompoundType","label":"filterable","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L21"},"signature":["boolean | undefined"]},{"id":"def-common.IFieldType.searchable","type":"CompoundType","label":"searchable","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L22"},"signature":["boolean | undefined"]},{"id":"def-common.IFieldType.sortable","type":"CompoundType","label":"sortable","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L23"},"signature":["boolean | undefined"]},{"id":"def-common.IFieldType.visualizable","type":"CompoundType","label":"visualizable","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L24"},"signature":["boolean | undefined"]},{"id":"def-common.IFieldType.readFromDocValues","type":"CompoundType","label":"readFromDocValues","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L25"},"signature":["boolean | undefined"]},{"id":"def-common.IFieldType.scripted","type":"CompoundType","label":"scripted","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L26"},"signature":["boolean | undefined"]},{"id":"def-common.IFieldType.subType","type":"Object","label":"subType","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L27"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldSubType","text":"IFieldSubType"}," | undefined"]},{"id":"def-common.IFieldType.displayName","type":"string","label":"displayName","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L28"},"signature":["string | undefined"]},{"id":"def-common.IFieldType.customLabel","type":"string","label":"customLabel","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L29"},"signature":["string | undefined"]},{"id":"def-common.IFieldType.format","type":"Any","label":"format","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L30"},"signature":["any"]},{"id":"def-common.IFieldType.toSpec","type":"Function","label":"toSpec","description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L31"},"signature":["((options?: { getFormatterForField?: ((field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"},") | undefined; } | undefined) => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"}]}],"source":{"path":"src/plugins/data/common/index_patterns/fields/types.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/types.ts#L11"},"initialIsOpen":false},{"id":"def-common.IIndexPatternFieldList","type":"Interface","label":"IIndexPatternFieldList","signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPatternFieldList","text":"IIndexPatternFieldList"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"},"[]"],"description":[],"children":[{"id":"def-common.IIndexPatternFieldList.add","type":"Function","label":"add","signature":["(field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},") => void"],"description":[],"children":[{"type":"Object","label":"field","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L18"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L18"}},{"id":"def-common.IIndexPatternFieldList.getAll","type":"Function","label":"getAll","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L19"}},{"id":"def-common.IIndexPatternFieldList.getByName","type":"Function","label":"getByName","signature":["(name: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"}," | undefined"],"description":[],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L20"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L20"}},{"id":"def-common.IIndexPatternFieldList.getByType","type":"Function","label":"getByType","signature":["(type: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"},"[]"],"description":[],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L21"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L21"}},{"id":"def-common.IIndexPatternFieldList.remove","type":"Function","label":"remove","signature":["(field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"},") => void"],"description":[],"children":[{"type":"Object","label":"field","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L22"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L22"}},{"id":"def-common.IIndexPatternFieldList.removeAll","type":"Function","label":"removeAll","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L23"}},{"id":"def-common.IIndexPatternFieldList.replaceAll","type":"Function","label":"replaceAll","signature":["(specs: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},"[]) => void"],"description":[],"children":[{"type":"Array","label":"specs","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},"[]"],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L24"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L24"}},{"id":"def-common.IIndexPatternFieldList.update","type":"Function","label":"update","signature":["(field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},") => void"],"description":[],"children":[{"type":"Object","label":"field","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"}],"description":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L25"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L25"}},{"id":"def-common.IIndexPatternFieldList.toSpec","type":"Function","label":"toSpec","signature":["(options?: { getFormatterForField?: ((field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"},") | undefined; } | undefined) => Record ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"},") | undefined"]}],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L26"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L26"}}],"source":{"path":"src/plugins/data/common/index_patterns/fields/field_list.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/fields/field_list.ts#L17"},"initialIsOpen":false},{"id":"def-common.RuntimeField","type":"Interface","label":"RuntimeField","description":[],"children":[{"id":"def-common.RuntimeField.type","type":"CompoundType","label":"type","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L21"},"signature":["\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\""]},{"id":"def-common.RuntimeField.script","type":"Object","label":"script","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L22"},"signature":["{ source: string; } | undefined"]}],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L20"},"initialIsOpen":false},{"id":"def-common.IIndexPattern","type":"Interface","label":"IIndexPattern","description":["\nIIndexPattern allows for an IndexPattern OR an index pattern saved object\ntoo ambiguous, should be avoided"],"children":[{"id":"def-common.IIndexPattern.fields","type":"Array","label":"fields","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L32"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"},"[]"]},{"id":"def-common.IIndexPattern.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L33"}},{"id":"def-common.IIndexPattern.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L34"},"signature":["string | undefined"]},{"id":"def-common.IIndexPattern.type","type":"string","label":"type","description":["\nType is used for identifying rollup indices, otherwise left undefined"],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L38"},"signature":["string | undefined"]},{"id":"def-common.IIndexPattern.timeFieldName","type":"string","label":"timeFieldName","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L39"},"signature":["string | undefined"]},{"id":"def-common.IIndexPattern.getTimeField","type":"Function","label":"getTimeField","signature":["(() => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}," | undefined) | undefined"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L40"}},{"id":"def-common.IIndexPattern.fieldFormatMap","type":"Object","label":"fieldFormatMap","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L41"},"signature":["Record | undefined> | undefined"]},{"id":"def-common.IIndexPattern.getFormatterForField","type":"Function","label":"getFormatterForField","description":["\nLook up a formatter for a given field"],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L45"},"signature":["((field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldSpec","text":"FieldSpec"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataFieldFormatsPluginApi","section":"def-common.FieldFormat","text":"FieldFormat"},") | undefined"]}],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L31"},"initialIsOpen":false},{"id":"def-common.FieldAttrs","type":"Interface","label":"FieldAttrs","description":[],"children":[{"id":"def-common.FieldAttrs.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L75"},"signature":["any"]}],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L74"},"initialIsOpen":false},{"id":"def-common.FieldAttrSet","type":"Interface","label":"FieldAttrSet","description":[],"children":[{"id":"def-common.FieldAttrSet.customLabel","type":"string","label":"customLabel","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L79"},"signature":["string | undefined"]},{"id":"def-common.FieldAttrSet.count","type":"number","label":"count","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L80"},"signature":["number | undefined"]}],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L78"},"initialIsOpen":false},{"id":"def-common.UiSettingsCommon","type":"Interface","label":"UiSettingsCommon","description":[],"children":[{"id":"def-common.UiSettingsCommon.get","type":"Function","label":"get","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":87,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L87"},"signature":["(key: string) => Promise"]},{"id":"def-common.UiSettingsCommon.getAll","type":"Function","label":"getAll","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L88"},"signature":["() => Promise>"]},{"id":"def-common.UiSettingsCommon.set","type":"Function","label":"set","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L89"},"signature":["(key: string, value: any) => Promise"]},{"id":"def-common.UiSettingsCommon.remove","type":"Function","label":"remove","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L90"},"signature":["(key: string) => Promise"]}],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L86"},"initialIsOpen":false},{"id":"def-common.SavedObjectsClientCommonFindArgs","type":"Interface","label":"SavedObjectsClientCommonFindArgs","description":[],"children":[{"id":"def-common.SavedObjectsClientCommonFindArgs.type","type":"CompoundType","label":"type","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L94"},"signature":["string | string[]"]},{"id":"def-common.SavedObjectsClientCommonFindArgs.fields","type":"Array","label":"fields","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L95"},"signature":["string[] | undefined"]},{"id":"def-common.SavedObjectsClientCommonFindArgs.perPage","type":"number","label":"perPage","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L96"},"signature":["number | undefined"]},{"id":"def-common.SavedObjectsClientCommonFindArgs.search","type":"string","label":"search","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L97"},"signature":["string | undefined"]},{"id":"def-common.SavedObjectsClientCommonFindArgs.searchFields","type":"Array","label":"searchFields","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L98"},"signature":["string[] | undefined"]}],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":93,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L93"},"initialIsOpen":false},{"id":"def-common.SavedObjectsClientCommon","type":"Interface","label":"SavedObjectsClientCommon","description":[],"children":[{"id":"def-common.SavedObjectsClientCommon.find","type":"Function","label":"find","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L102"},"signature":["(options: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.SavedObjectsClientCommonFindArgs","text":"SavedObjectsClientCommonFindArgs"},") => Promise<",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},"[]>"]},{"id":"def-common.SavedObjectsClientCommon.get","type":"Function","label":"get","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L103"},"signature":["(type: string, id: string) => Promise<",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},">"]},{"id":"def-common.SavedObjectsClientCommon.update","type":"Function","label":"update","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L104"},"signature":["(type: string, id: string, attributes: Record, options: Record) => Promise<",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},">"]},{"id":"def-common.SavedObjectsClientCommon.create","type":"Function","label":"create","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L110"},"signature":["(type: string, attributes: Record, options: Record) => Promise<",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},">"]},{"id":"def-common.SavedObjectsClientCommon.delete","type":"Function","label":"delete","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L115"},"signature":["(type: string, id: string) => Promise<{}>"]}],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L101"},"initialIsOpen":false},{"id":"def-common.GetFieldsOptions","type":"Interface","label":"GetFieldsOptions","description":[],"children":[{"id":"def-common.GetFieldsOptions.pattern","type":"string","label":"pattern","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":119,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L119"}},{"id":"def-common.GetFieldsOptions.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":120,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L120"},"signature":["string | undefined"]},{"id":"def-common.GetFieldsOptions.lookBack","type":"CompoundType","label":"lookBack","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":121,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L121"},"signature":["boolean | undefined"]},{"id":"def-common.GetFieldsOptions.metaFields","type":"Array","label":"metaFields","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":122,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L122"},"signature":["string[] | undefined"]},{"id":"def-common.GetFieldsOptions.rollupIndex","type":"string","label":"rollupIndex","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":123,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L123"},"signature":["string | undefined"]},{"id":"def-common.GetFieldsOptions.allowNoIndex","type":"CompoundType","label":"allowNoIndex","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":124,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L124"},"signature":["boolean | undefined"]}],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":118,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L118"},"initialIsOpen":false},{"id":"def-common.GetFieldsOptionsTimePattern","type":"Interface","label":"GetFieldsOptionsTimePattern","description":[],"children":[{"id":"def-common.GetFieldsOptionsTimePattern.pattern","type":"string","label":"pattern","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":128,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L128"}},{"id":"def-common.GetFieldsOptionsTimePattern.metaFields","type":"Array","label":"metaFields","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":129,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L129"},"signature":["string[]"]},{"id":"def-common.GetFieldsOptionsTimePattern.lookBack","type":"number","label":"lookBack","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":130,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L130"}},{"id":"def-common.GetFieldsOptionsTimePattern.interval","type":"string","label":"interval","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L131"}}],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":127,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L127"},"initialIsOpen":false},{"id":"def-common.IIndexPatternsApiClient","type":"Interface","label":"IIndexPatternsApiClient","description":[],"children":[{"id":"def-common.IIndexPatternsApiClient.getFieldsForTimePattern","type":"Function","label":"getFieldsForTimePattern","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":135,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L135"},"signature":["(options: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.GetFieldsOptionsTimePattern","text":"GetFieldsOptionsTimePattern"},") => Promise"]},{"id":"def-common.IIndexPatternsApiClient.getFieldsForWildcard","type":"Function","label":"getFieldsForWildcard","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":136,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L136"},"signature":["(options: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.GetFieldsOptions","text":"GetFieldsOptions"},") => Promise"]}],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":134,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L134"},"initialIsOpen":false},{"id":"def-common.IFieldSubType","type":"Interface","label":"IFieldSubType","description":[],"children":[{"id":"def-common.IFieldSubType.multi","type":"Object","label":"multi","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":154,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L154"},"signature":["{ parent: string; } | undefined"]},{"id":"def-common.IFieldSubType.nested","type":"Object","label":"nested","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":155,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L155"},"signature":["{ path: string; } | undefined"]}],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":153,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L153"},"initialIsOpen":false},{"id":"def-common.TypeMeta","type":"Interface","label":"TypeMeta","description":[],"children":[{"id":"def-common.TypeMeta.aggs","type":"Object","label":"aggs","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":159,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L159"},"signature":["Record> | undefined"]},{"id":"def-common.TypeMeta.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":160,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L160"},"signature":["any"]}],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":158,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L158"},"initialIsOpen":false},{"id":"def-common.FieldSpecExportFmt","type":"Interface","label":"FieldSpecExportFmt","description":[],"children":[{"id":"def-common.FieldSpecExportFmt.count","type":"number","label":"count","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":167,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L167"},"signature":["number | undefined"]},{"id":"def-common.FieldSpecExportFmt.script","type":"string","label":"script","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":168,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L168"},"signature":["string | undefined"]},{"id":"def-common.FieldSpecExportFmt.lang","type":"string","label":"lang","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":169,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L169"},"signature":["string | undefined"]},{"id":"def-common.FieldSpecExportFmt.conflictDescriptions","type":"Object","label":"conflictDescriptions","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":170,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L170"},"signature":["Record | undefined"]},{"id":"def-common.FieldSpecExportFmt.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":171,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L171"}},{"id":"def-common.FieldSpecExportFmt.type","type":"Enum","label":"type","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":172,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L172"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"}]},{"id":"def-common.FieldSpecExportFmt.esTypes","type":"Array","label":"esTypes","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":173,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L173"},"signature":["string[] | undefined"]},{"id":"def-common.FieldSpecExportFmt.scripted","type":"boolean","label":"scripted","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":174,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L174"}},{"id":"def-common.FieldSpecExportFmt.searchable","type":"boolean","label":"searchable","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":175,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L175"}},{"id":"def-common.FieldSpecExportFmt.aggregatable","type":"boolean","label":"aggregatable","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":176,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L176"}},{"id":"def-common.FieldSpecExportFmt.readFromDocValues","type":"CompoundType","label":"readFromDocValues","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":177,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L177"},"signature":["boolean | undefined"]},{"id":"def-common.FieldSpecExportFmt.subType","type":"Object","label":"subType","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":178,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L178"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldSubType","text":"IFieldSubType"}," | undefined"]},{"id":"def-common.FieldSpecExportFmt.format","type":"Object","label":"format","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":179,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L179"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializedFieldFormat","text":"SerializedFieldFormat"},"> | undefined"]},{"id":"def-common.FieldSpecExportFmt.indexed","type":"CompoundType","label":"indexed","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":180,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L180"},"signature":["boolean | undefined"]}],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":166,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L166"},"initialIsOpen":false},{"id":"def-common.FieldSpec","type":"Interface","label":"FieldSpec","description":["\nSerialized version of IndexPatternField"],"children":[{"id":"def-common.FieldSpec.count","type":"number","label":"count","description":["\nPopularity count is used by discover"],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":190,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L190"},"signature":["number | undefined"]},{"id":"def-common.FieldSpec.script","type":"string","label":"script","description":["\nScripted field painless script"],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":194,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L194"},"signature":["string | undefined"]},{"id":"def-common.FieldSpec.lang","type":"string","label":"lang","description":["\nScripted field langauge\nPainless is the only valid scripted field language"],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":199,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L199"},"signature":["string | undefined"]},{"id":"def-common.FieldSpec.conflictDescriptions","type":"Object","label":"conflictDescriptions","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":200,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L200"},"signature":["Record | undefined"]},{"id":"def-common.FieldSpec.format","type":"Object","label":"format","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":201,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L201"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializedFieldFormat","text":"SerializedFieldFormat"},"> | undefined"]},{"id":"def-common.FieldSpec.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":202,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L202"}},{"id":"def-common.FieldSpec.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":203,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L203"}},{"id":"def-common.FieldSpec.esTypes","type":"Array","label":"esTypes","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":204,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L204"},"signature":["string[] | undefined"]},{"id":"def-common.FieldSpec.scripted","type":"CompoundType","label":"scripted","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":205,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L205"},"signature":["boolean | undefined"]},{"id":"def-common.FieldSpec.searchable","type":"boolean","label":"searchable","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":206,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L206"}},{"id":"def-common.FieldSpec.aggregatable","type":"boolean","label":"aggregatable","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":207,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L207"}},{"id":"def-common.FieldSpec.readFromDocValues","type":"CompoundType","label":"readFromDocValues","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":208,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L208"},"signature":["boolean | undefined"]},{"id":"def-common.FieldSpec.subType","type":"Object","label":"subType","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":209,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L209"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldSubType","text":"IFieldSubType"}," | undefined"]},{"id":"def-common.FieldSpec.indexed","type":"CompoundType","label":"indexed","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":210,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L210"},"signature":["boolean | undefined"]},{"id":"def-common.FieldSpec.customLabel","type":"string","label":"customLabel","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":211,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L211"},"signature":["string | undefined"]},{"id":"def-common.FieldSpec.runtimeField","type":"Object","label":"runtimeField","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":212,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L212"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.RuntimeField","text":"RuntimeField"}," | undefined"]},{"id":"def-common.FieldSpec.shortDotsEnable","type":"CompoundType","label":"shortDotsEnable","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":214,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L214"},"signature":["boolean | undefined"]},{"id":"def-common.FieldSpec.isMapped","type":"CompoundType","label":"isMapped","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":215,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L215"},"signature":["boolean | undefined"]}],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":186,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L186"},"initialIsOpen":false},{"id":"def-common.IndexPatternSpec","type":"Interface","label":"IndexPatternSpec","description":["\nStatic index pattern format\nSerialized data object, representing index pattern attributes and state"],"children":[{"id":"def-common.IndexPatternSpec.id","type":"string","label":"id","description":["\nsaved object id"],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":228,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L228"},"signature":["string | undefined"]},{"id":"def-common.IndexPatternSpec.version","type":"string","label":"version","description":["\nsaved object version string"],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":232,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L232"},"signature":["string | undefined"]},{"id":"def-common.IndexPatternSpec.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":233,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L233"},"signature":["string | undefined"]},{"id":"def-common.IndexPatternSpec.intervalName","type":"string","label":"intervalName","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":238,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L238"},"signature":["string | undefined"]},{"id":"def-common.IndexPatternSpec.timeFieldName","type":"string","label":"timeFieldName","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":239,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L239"},"signature":["string | undefined"]},{"id":"def-common.IndexPatternSpec.sourceFilters","type":"Array","label":"sourceFilters","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":240,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L240"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.SourceFilter","text":"SourceFilter"},"[] | undefined"]},{"id":"def-common.IndexPatternSpec.fields","type":"Object","label":"fields","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":241,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L241"},"signature":["Record | undefined"]},{"id":"def-common.IndexPatternSpec.typeMeta","type":"Object","label":"typeMeta","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":242,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L242"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.TypeMeta","text":"TypeMeta"}," | undefined"]},{"id":"def-common.IndexPatternSpec.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":243,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L243"},"signature":["string | undefined"]},{"id":"def-common.IndexPatternSpec.fieldFormats","type":"Object","label":"fieldFormats","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":244,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L244"},"signature":["Record>> | undefined"]},{"id":"def-common.IndexPatternSpec.runtimeFieldMap","type":"Object","label":"runtimeFieldMap","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":245,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L245"},"signature":["Record | undefined"]},{"id":"def-common.IndexPatternSpec.fieldAttrs","type":"Object","label":"fieldAttrs","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":246,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L246"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.FieldAttrs","text":"FieldAttrs"}," | undefined"]},{"id":"def-common.IndexPatternSpec.allowNoIndex","type":"CompoundType","label":"allowNoIndex","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":247,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L247"},"signature":["boolean | undefined"]}],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":224,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L224"},"initialIsOpen":false},{"id":"def-common.SourceFilter","type":"Interface","label":"SourceFilter","description":[],"children":[{"id":"def-common.SourceFilter.value","type":"string","label":"value","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":251,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L251"}}],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":250,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L250"},"initialIsOpen":false},{"id":"def-common.IndexPatternExpressionType","type":"Interface","label":"IndexPatternExpressionType","description":[],"children":[{"id":"def-common.IndexPatternExpressionType.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/expressions/load_index_pattern.ts#L18"},"signature":["\"index_pattern\""]},{"id":"def-common.IndexPatternExpressionType.value","type":"Object","label":"value","description":[],"source":{"path":"src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/expressions/load_index_pattern.ts#L19"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternSpec","text":"IndexPatternSpec"}]}],"source":{"path":"src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/expressions/load_index_pattern.ts#L17"},"initialIsOpen":false},{"id":"def-common.IndexPatternLoadStartDependencies","type":"Interface","label":"IndexPatternLoadStartDependencies","description":[],"children":[{"id":"def-common.IndexPatternLoadStartDependencies.indexPatterns","type":"Object","label":"indexPatterns","description":[],"source":{"path":"src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/expressions/load_index_pattern.ts#L31"},"signature":["Pick<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternsService","text":"IndexPatternsService"},", \"get\" | \"delete\" | \"create\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"find\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">"]}],"source":{"path":"src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/expressions/load_index_pattern.ts#L30"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-common.IndexPatternsContract","type":"Type","label":"IndexPatternsContract","description":[],"source":{"path":"src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts","lineNumber":638,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/index_patterns/index_patterns.ts#L638"},"signature":["{ get: (id: string) => Promise; delete: (indexPatternId: string) => Promise<{}>; create: (spec: IndexPatternSpec, skipFetchFields?: boolean) => Promise; ensureDefaultIndexPattern: EnsureDefaultIndexPattern; getIds: (refresh?: boolean) => Promise; getTitles: (refresh?: boolean) => Promise; find: (search: string, size?: number) => Promise; getIdsWithTitle: (refresh?: boolean) => Promise<{ id: string; title: string; }[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise[] | null | undefined>; getDefault: () => Promise; setDefault: (id: string, force?: boolean) => Promise; getFieldsForWildcard: (options: GetFieldsOptions) => Promise; getFieldsForIndexPattern: (indexPattern: IndexPattern | IndexPatternSpec, options?: GetFieldsOptions | undefined) => Promise; refreshFields: (indexPattern: IndexPattern) => Promise; fieldArrayToMap: (fields: FieldSpec[], fieldAttrs?: FieldAttrs | undefined) => Record; savedObjectToSpec: (savedObject: SavedObject) => IndexPatternSpec; createAndSave: (spec: IndexPatternSpec, override?: boolean, skipFetchFields?: boolean) => Promise; createSavedObject: (indexPattern: IndexPattern, override?: boolean) => Promise; updateSavedObject: (indexPattern: IndexPattern, saveAttempts?: number, ignoreErrors?: boolean) => Promise; }"],"initialIsOpen":false},{"id":"def-common.FieldFormatMap","type":"Type","label":"FieldFormatMap","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L17"},"signature":["{ [x: string]: SerializedFieldFormat>; }"],"initialIsOpen":false},{"id":"def-common.RuntimeType","type":"Type","label":"RuntimeType","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L19"},"signature":["\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\""],"initialIsOpen":false},{"id":"def-common.OnNotification","type":"Type","label":"OnNotification","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L83"},"signature":["(toastInputFields: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastInputFields","text":"ToastInputFields"},") => void"],"initialIsOpen":false},{"id":"def-common.OnError","type":"Type","label":"OnError","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L84"},"signature":["(error: Error, toastInputFields: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ErrorToastOptions","text":"ErrorToastOptions"},") => void"],"initialIsOpen":false},{"id":"def-common.AggregationRestrictions","type":"Type","label":"AggregationRestrictions","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":141,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L141"},"signature":["{ [x: string]: { agg?: string | undefined; interval?: number | undefined; fixed_interval?: string | undefined; calendar_interval?: string | undefined; delay?: string | undefined; time_zone?: string | undefined; }; }"],"initialIsOpen":false},{"id":"def-common.FieldSpecConflictDescriptions","type":"Type","label":"FieldSpecConflictDescriptions","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":163,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L163"},"signature":["{ [x: string]: string[]; }"],"initialIsOpen":false},{"id":"def-common.IndexPatternFieldMap","type":"Type","label":"IndexPatternFieldMap","description":[],"source":{"path":"src/plugins/data/common/index_patterns/types.ts","lineNumber":218,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/types.ts#L218"},"signature":["{ [x: string]: FieldSpec; }"],"initialIsOpen":false},{"id":"def-common.IndexPatternLoadExpressionFunctionDefinition","type":"Type","label":"IndexPatternLoadExpressionFunctionDefinition","description":[],"source":{"path":"src/plugins/data/common/index_patterns/expressions/load_index_pattern.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/expressions/load_index_pattern.ts#L34"},"signature":["ExpressionFunctionDefinition<\"indexPatternLoad\", null, Arguments, Output, ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},"<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},">>"],"initialIsOpen":false}],"objects":[{"id":"def-common.RUNTIME_FIELD_TYPES","type":"Object","label":"RUNTIME_FIELD_TYPES","description":[],"source":{"path":"src/plugins/data/common/index_patterns/constants.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/index_patterns/constants.ts#L9"},"signature":["readonly [\"keyword\", \"long\", \"double\", \"date\", \"ip\", \"boolean\"]"],"initialIsOpen":false}]}} \ No newline at end of file diff --git a/api_docs/data_index_patterns.mdx b/api_docs/data_index_patterns.mdx new file mode 100644 index 0000000000000..8145948d47541 --- /dev/null +++ b/api_docs/data_index_patterns.mdx @@ -0,0 +1,32 @@ +--- +id: kibDataIndexPatternsPluginApi +slug: /kibana-dev-docs/data.indexPatternsPluginApi +title: data.indexPatterns +image: https://source.unsplash.com/400x175/?github +summary: API docs for the data.indexPatterns plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.indexPatterns'] +--- + +import dataIndexPatternsObj from './data_index_patterns.json'; + +## Server + +### Functions + +### Classes + +### Interfaces + +## Common + +### Objects + +### Functions + +### Classes + +### Interfaces + +### Consts, variables and types + diff --git a/api_docs/data_query.json b/api_docs/data_query.json new file mode 100644 index 0000000000000..4b36929152430 --- /dev/null +++ b/api_docs/data_query.json @@ -0,0 +1 @@ +{"id":"data.query","client":{"classes":[{"id":"def-public.FilterManager","type":"Class","label":"FilterManager","description":[],"children":[{"id":"def-public.FilterManager.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"uiSettings","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.IUiSettingsClient","text":"IUiSettingsClient"}],"description":[],"source":{"path":"src/plugins/data/public/query/filter_manager/filter_manager.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L35"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/query/filter_manager/filter_manager.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L35"}},{"id":"def-public.FilterManager.getFilters","type":"Function","label":"getFilters","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/query/filter_manager/filter_manager.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L92"}},{"id":"def-public.FilterManager.getAppFilters","type":"Function","label":"getAppFilters","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/query/filter_manager/filter_manager.ts","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L96"}},{"id":"def-public.FilterManager.getGlobalFilters","type":"Function","label":"getGlobalFilters","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/query/filter_manager/filter_manager.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L101"}},{"id":"def-public.FilterManager.getPartitionedFilters","type":"Function","label":"getPartitionedFilters","signature":["() => ",{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.PartitionedFilters","text":"PartitionedFilters"}],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/query/filter_manager/filter_manager.ts","lineNumber":106,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L106"}},{"id":"def-public.FilterManager.getUpdates$","type":"Function","label":"getUpdates$","signature":["() => ","Observable",""],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/query/filter_manager/filter_manager.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L110"}},{"id":"def-public.FilterManager.getFetches$","type":"Function","label":"getFetches$","signature":["() => ","Observable",""],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/query/filter_manager/filter_manager.ts","lineNumber":114,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L114"}},{"id":"def-public.FilterManager.addFilters","type":"Function","label":"addFilters","signature":["(filters: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[], pinFilterStatus?: boolean) => void"],"description":[],"children":[{"type":"CompoundType","label":"filters","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]"],"description":[],"source":{"path":"src/plugins/data/public/query/filter_manager/filter_manager.ts","lineNumber":121,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L121"}},{"type":"boolean","label":"pinFilterStatus","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/public/query/filter_manager/filter_manager.ts","lineNumber":122,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L122"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/query/filter_manager/filter_manager.ts","lineNumber":120,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L120"}},{"id":"def-public.FilterManager.setFilters","type":"Function","label":"setFilters","signature":["(newFilters: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[], pinFilterStatus?: boolean) => void"],"description":[],"children":[{"type":"Array","label":"newFilters","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]"],"description":[],"source":{"path":"src/plugins/data/public/query/filter_manager/filter_manager.ts","lineNumber":149,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L149"}},{"type":"boolean","label":"pinFilterStatus","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/public/query/filter_manager/filter_manager.ts","lineNumber":150,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L150"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/query/filter_manager/filter_manager.ts","lineNumber":148,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L148"}},{"id":"def-public.FilterManager.setGlobalFilters","type":"Function","label":"setGlobalFilters","signature":["(newGlobalFilters: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]) => void"],"description":["\nSets new global filters and leaves app filters untouched,\nRemoves app filters for which there is a duplicate within new global filters"],"children":[{"type":"Array","label":"newGlobalFilters","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]"],"description":[],"source":{"path":"src/plugins/data/public/query/filter_manager/filter_manager.ts","lineNumber":167,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L167"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/query/filter_manager/filter_manager.ts","lineNumber":167,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L167"}},{"id":"def-public.FilterManager.setAppFilters","type":"Function","label":"setAppFilters","signature":["(newAppFilters: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]) => void"],"description":["\nSets new app filters and leaves global filters untouched,\nRemoves app filters for which there is a duplicate within new global filters"],"children":[{"type":"Array","label":"newAppFilters","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]"],"description":[],"source":{"path":"src/plugins/data/public/query/filter_manager/filter_manager.ts","lineNumber":184,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L184"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/query/filter_manager/filter_manager.ts","lineNumber":184,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L184"}},{"id":"def-public.FilterManager.removeFilter","type":"Function","label":"removeFilter","signature":["(filter: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},") => void"],"description":[],"children":[{"type":"Object","label":"filter","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}],"description":[],"source":{"path":"src/plugins/data/public/query/filter_manager/filter_manager.ts","lineNumber":195,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L195"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/query/filter_manager/filter_manager.ts","lineNumber":195,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L195"}},{"id":"def-public.FilterManager.removeAll","type":"Function","label":"removeAll","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/query/filter_manager/filter_manager.ts","lineNumber":207,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L207"}},{"id":"def-public.FilterManager.setFiltersStore","type":"Function","label":"setFiltersStore","signature":["typeof ",{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.FilterManager","text":"FilterManager"},".setFiltersStore"],"description":[],"children":[{"type":"Array","label":"filters","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]"],"description":[],"source":{"path":"src/plugins/data/public/query/filter_manager/filter_manager.ts","lineNumber":212,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L212"}},{"type":"Enum","label":"store","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.FilterStateStore","text":"FilterStateStore"}],"description":[],"source":{"path":"src/plugins/data/public/query/filter_manager/filter_manager.ts","lineNumber":213,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L213"}},{"type":"boolean","label":"shouldOverrideStore","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/public/query/filter_manager/filter_manager.ts","lineNumber":214,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L214"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/query/filter_manager/filter_manager.ts","lineNumber":211,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L211"}}],"source":{"path":"src/plugins/data/public/query/filter_manager/filter_manager.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/filter_manager/filter_manager.ts#L29"},"initialIsOpen":false},{"id":"def-public.TimeHistory","type":"Class","label":"TimeHistory","description":[],"children":[{"id":"def-public.TimeHistory.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"storage","isRequired":true,"signature":[{"pluginId":"kibanaUtils","scope":"public","docId":"kibKibanaUtilsPluginApi","section":"def-public.IStorageWrapper","text":"IStorageWrapper"},""],"description":[],"source":{"path":"src/plugins/data/public/query/timefilter/time_history.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/timefilter/time_history.ts#L18"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/query/timefilter/time_history.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/timefilter/time_history.ts#L18"}},{"id":"def-public.TimeHistory.add","type":"Function","label":"add","signature":["(time: ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"},") => void"],"description":[],"children":[{"type":"Object","label":"time","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"}],"description":[],"source":{"path":"src/plugins/data/public/query/timefilter/time_history.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/timefilter/time_history.ts#L29"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/query/timefilter/time_history.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/timefilter/time_history.ts#L29"}},{"id":"def-public.TimeHistory.get","type":"Function","label":"get","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/query/timefilter/time_history.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/timefilter/time_history.ts#L42"}}],"source":{"path":"src/plugins/data/public/query/timefilter/time_history.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/timefilter/time_history.ts#L15"},"initialIsOpen":false}],"functions":[{"id":"def-public.createSavedQueryService","type":"Function","children":[{"type":"Object","label":"savedObjectsClient","isRequired":true,"signature":["Pick<",{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\">"],"description":[],"source":{"path":"src/plugins/data/public/query/saved_query/saved_query_service.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/saved_query_service.ts#L21"}}],"signature":["(savedObjectsClient: Pick<",{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\">) => ",{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.SavedQueryService","text":"SavedQueryService"}],"description":[],"label":"createSavedQueryService","source":{"path":"src/plugins/data/public/query/saved_query/saved_query_service.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/saved_query_service.ts#L20"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.connectToQueryState","type":"Function","children":[{"type":"Object","label":"{\n timefilter: { timefilter },\n filterManager,\n queryString,\n state$,\n }","isRequired":true,"signature":["Pick<{ addToQueryLog: (appName: string, { language, query }: ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.Query","text":"Query"},") => void; filterManager: ",{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.FilterManager","text":"FilterManager"},"; queryString: Pick<",{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.QueryStringManager","text":"QueryStringManager"},", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ",{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.SavedQueryService","text":"SavedQueryService"},"; state$: ","Observable"],"description":[],"source":{"path":"src/plugins/data/public/query/state_sync/connect_to_query_state.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/connect_to_query_state.ts#L24"}},{"type":"Object","label":"stateContainer","isRequired":true,"signature":[{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.BaseStateContainer","text":"BaseStateContainer"},""],"description":[],"source":{"path":"src/plugins/data/public/query/state_sync/connect_to_query_state.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/connect_to_query_state.ts#L30"}},{"id":"def-public.connectToQueryState.syncConfig","type":"Object","label":"syncConfig","description":[],"children":[{"id":"def-public.connectToQueryState.syncConfig.time","type":"CompoundType","label":"time","description":[],"source":{"path":"src/plugins/data/public/query/state_sync/connect_to_query_state.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/connect_to_query_state.ts#L32"},"signature":["boolean | undefined"]},{"id":"def-public.connectToQueryState.syncConfig.refreshInterval","type":"CompoundType","label":"refreshInterval","description":[],"source":{"path":"src/plugins/data/public/query/state_sync/connect_to_query_state.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/connect_to_query_state.ts#L33"},"signature":["boolean | undefined"]},{"id":"def-public.connectToQueryState.syncConfig.filters","type":"CompoundType","label":"filters","description":[],"source":{"path":"src/plugins/data/public/query/state_sync/connect_to_query_state.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/connect_to_query_state.ts#L34"},"signature":["boolean | ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.FilterStateStore","text":"FilterStateStore"}," | undefined"]},{"id":"def-public.connectToQueryState.syncConfig.query","type":"CompoundType","label":"query","description":[],"source":{"path":"src/plugins/data/public/query/state_sync/connect_to_query_state.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/connect_to_query_state.ts#L35"},"signature":["boolean | undefined"]}],"source":{"path":"src/plugins/data/public/query/state_sync/connect_to_query_state.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/connect_to_query_state.ts#L31"}}],"signature":["({ timefilter: { timefilter }, filterManager, queryString, state$, }: Pick<{ addToQueryLog: (appName: string, { language, query }: ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.Query","text":"Query"},") => void; filterManager: ",{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.FilterManager","text":"FilterManager"},"; queryString: Pick<","QueryStringManager",", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ",{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.SavedQueryService","text":"SavedQueryService"}],"description":["\nHelper to setup two-way syncing of global data and a state container"],"label":"connectToQueryState","source":{"path":"src/plugins/data/public/query/state_sync/connect_to_query_state.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/connect_to_query_state.ts#L23"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.syncQueryStateWithUrl","type":"Function","children":[{"type":"Object","label":"query","isRequired":true,"signature":["Pick<{ addToQueryLog: (appName: string, { language, query }: ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.Query","text":"Query"},") => void; filterManager: ",{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.FilterManager","text":"FilterManager"},"; queryString: Pick<",{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.QueryStringManager","text":"QueryStringManager"},", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ",{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.SavedQueryService","text":"SavedQueryService"},"; state$: ","Observable"],"description":[],"source":{"path":"src/plugins/data/public/query/state_sync/sync_state_with_url.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/sync_state_with_url.ts#L27"}},{"type":"Object","label":"kbnUrlStateStorage","isRequired":true,"signature":[{"pluginId":"kibanaUtils","scope":"public","docId":"kibKibanaUtilsPluginApi","section":"def-public.IKbnUrlStateStorage","text":"IKbnUrlStateStorage"}],"description":[],"source":{"path":"src/plugins/data/public/query/state_sync/sync_state_with_url.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/sync_state_with_url.ts#L28"}}],"signature":["(query: Pick<{ addToQueryLog: (appName: string, { language, query }: ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.Query","text":"Query"},") => void; filterManager: ",{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.FilterManager","text":"FilterManager"},"; queryString: Pick<","QueryStringManager",", \"getDefaultQuery\" | \"formatQuery\" | \"getUpdates$\" | \"getQuery\" | \"setQuery\" | \"clearQuery\">; savedQueries: ",{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.SavedQueryService","text":"SavedQueryService"},"; state$: ","Observable"],"description":["\nHelper to setup syncing of global data with the URL"],"label":"syncQueryStateWithUrl","source":{"path":"src/plugins/data/public/query/state_sync/sync_state_with_url.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/sync_state_with_url.ts#L26"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.getDefaultQuery","type":"Function","label":"getDefaultQuery","signature":["(language: ","QueryLanguage",") => { query: string; language: ","QueryLanguage","; }"],"description":[],"children":[{"type":"CompoundType","label":"language","isRequired":true,"signature":[{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.QueryLanguage","text":"QueryLanguage"}],"description":[],"source":{"path":"src/plugins/data/public/query/lib/get_default_query.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/lib/get_default_query.ts#L11"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/query/lib/get_default_query.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/lib/get_default_query.ts#L11"},"initialIsOpen":false}],"interfaces":[{"id":"def-public.QueryState","type":"Interface","label":"QueryState","description":["\nAll query state service state"],"children":[{"id":"def-public.QueryState.time","type":"Object","label":"time","description":[],"source":{"path":"src/plugins/data/public/query/state_sync/types.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/types.ts#L15"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"}," | undefined"]},{"id":"def-public.QueryState.refreshInterval","type":"Object","label":"refreshInterval","description":[],"source":{"path":"src/plugins/data/public/query/state_sync/types.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/types.ts#L16"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.RefreshInterval","text":"RefreshInterval"}," | undefined"]},{"id":"def-public.QueryState.filters","type":"Array","label":"filters","description":[],"source":{"path":"src/plugins/data/public/query/state_sync/types.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/types.ts#L17"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[] | undefined"]},{"id":"def-public.QueryState.query","type":"Object","label":"query","description":[],"source":{"path":"src/plugins/data/public/query/state_sync/types.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/types.ts#L18"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.Query","text":"Query"}," | undefined"]}],"source":{"path":"src/plugins/data/public/query/state_sync/types.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/types.ts#L14"},"initialIsOpen":false},{"id":"def-public.SavedQuery","type":"Interface","label":"SavedQuery","description":[],"children":[{"id":"def-public.SavedQuery.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/data/public/query/saved_query/types.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L16"}},{"id":"def-public.SavedQuery.attributes","type":"Object","label":"attributes","description":[],"source":{"path":"src/plugins/data/public/query/saved_query/types.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L17"},"signature":[{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.SavedQueryAttributes","text":"SavedQueryAttributes"}]}],"source":{"path":"src/plugins/data/public/query/saved_query/types.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L15"},"initialIsOpen":false},{"id":"def-public.SavedQueryService","type":"Interface","label":"SavedQueryService","description":[],"children":[{"id":"def-public.SavedQueryService.saveQuery","type":"Function","label":"saveQuery","description":[],"source":{"path":"src/plugins/data/public/query/saved_query/types.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L29"},"signature":["(attributes: ",{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.SavedQueryAttributes","text":"SavedQueryAttributes"},", config?: { overwrite: boolean; } | undefined) => Promise<",{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.SavedQuery","text":"SavedQuery"},">"]},{"id":"def-public.SavedQueryService.getAllSavedQueries","type":"Function","label":"getAllSavedQueries","description":[],"source":{"path":"src/plugins/data/public/query/saved_query/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L33"},"signature":["() => Promise<",{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.SavedQuery","text":"SavedQuery"},"[]>"]},{"id":"def-public.SavedQueryService.findSavedQueries","type":"Function","label":"findSavedQueries","description":[],"source":{"path":"src/plugins/data/public/query/saved_query/types.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L34"},"signature":["(searchText?: string | undefined, perPage?: number | undefined, activePage?: number | undefined) => Promise<{ total: number; queries: ",{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.SavedQuery","text":"SavedQuery"},"[]; }>"]},{"id":"def-public.SavedQueryService.getSavedQuery","type":"Function","label":"getSavedQuery","description":[],"source":{"path":"src/plugins/data/public/query/saved_query/types.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L39"},"signature":["(id: string) => Promise<",{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.SavedQuery","text":"SavedQuery"},">"]},{"id":"def-public.SavedQueryService.deleteSavedQuery","type":"Function","label":"deleteSavedQuery","description":[],"source":{"path":"src/plugins/data/public/query/saved_query/types.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L40"},"signature":["(id: string) => Promise<{}>"]},{"id":"def-public.SavedQueryService.getSavedQueryCount","type":"Function","label":"getSavedQueryCount","description":[],"source":{"path":"src/plugins/data/public/query/saved_query/types.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L41"},"signature":["() => Promise"]}],"source":{"path":"src/plugins/data/public/query/saved_query/types.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L28"},"initialIsOpen":false},{"id":"def-public.QueryStateChange","type":"Interface","label":"QueryStateChange","signature":[{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.QueryStateChange","text":"QueryStateChange"}," extends QueryStateChangePartial"],"description":[],"children":[{"id":"def-public.QueryStateChange.appFilters","type":"CompoundType","label":"appFilters","description":[],"source":{"path":"src/plugins/data/public/query/state_sync/types.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/types.ts#L26"},"signature":["boolean | undefined"]},{"id":"def-public.QueryStateChange.globalFilters","type":"CompoundType","label":"globalFilters","description":[],"source":{"path":"src/plugins/data/public/query/state_sync/types.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/types.ts#L27"},"signature":["boolean | undefined"]}],"source":{"path":"src/plugins/data/public/query/state_sync/types.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/state_sync/types.ts#L25"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-public.SavedQueryTimeFilter","type":"Type","label":"SavedQueryTimeFilter","description":[],"source":{"path":"src/plugins/data/public/query/saved_query/types.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/saved_query/types.ts#L11"},"signature":["TimeRange & { refreshInterval: RefreshInterval; }"],"initialIsOpen":false},{"id":"def-public.InputTimeRange","type":"Type","label":"InputTimeRange","description":[],"source":{"path":"src/plugins/data/public/query/timefilter/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/timefilter/types.ts#L19"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"}," | { from: moment.Moment; to: moment.Moment; }"],"initialIsOpen":false},{"id":"def-public.TimefilterContract","type":"Type","label":"TimefilterContract","description":[],"source":{"path":"src/plugins/data/public/query/timefilter/timefilter.ts","lineNumber":240,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/timefilter/timefilter.ts#L240"},"signature":["{ isTimeRangeSelectorEnabled: () => boolean; isAutoRefreshSelectorEnabled: () => boolean; isTimeTouched: () => boolean; getEnabledUpdated$: () => ","Observable","; getTimeUpdate$: () => ","Observable","; getRefreshIntervalUpdate$: () => ","Observable","; getAutoRefreshFetch$: () => ","Observable","; getFetch$: () => ","Observable"],"initialIsOpen":false},{"id":"def-public.TimeHistoryContract","type":"Type","label":"TimeHistoryContract","description":[],"source":{"path":"src/plugins/data/public/query/timefilter/time_history.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/timefilter/time_history.ts#L47"},"signature":["{ add: (time: TimeRange) => void; get: () => TimeRange[]; }"],"initialIsOpen":false},{"id":"def-public.QueryStart","type":"Type","label":"QueryStart","description":[],"source":{"path":"src/plugins/data/public/query/query_service.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/query/query_service.ts#L103"},"signature":["{ addToQueryLog: (appName: string, { language, query }: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Query","text":"Query"},") => void; filterManager: FilterManager; queryString: Pick; savedQueries: ",{"pluginId":"data","scope":"public","docId":"kibDataPluginApi","section":"def-public.SavedQueryService","text":"SavedQueryService"},"; state$: ","Observable","<{ changes: ",{"pluginId":"data","scope":"public","docId":"kibDataPluginApi","section":"def-public.QueryStateChange","text":"QueryStateChange"},"; state: ",{"pluginId":"data","scope":"public","docId":"kibDataPluginApi","section":"def-public.QueryState","text":"QueryState"}],"initialIsOpen":false}],"objects":[]},"server":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"common":{"classes":[],"functions":[{"id":"def-common.dedupFilters","type":"Function","children":[{"type":"Array","label":"existingFilters","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]"],"description":[],"source":{"path":"src/plugins/data/common/query/filter_manager/dedup_filters.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/dedup_filters.ts#L23"}},{"type":"Array","label":"filters","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]"],"description":[],"source":{"path":"src/plugins/data/common/query/filter_manager/dedup_filters.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/dedup_filters.ts#L24"}},{"type":"Object","label":"comparatorOptions","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.FilterCompareOptions","text":"FilterCompareOptions"}],"description":[],"source":{"path":"src/plugins/data/common/query/filter_manager/dedup_filters.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/dedup_filters.ts#L25"}}],"signature":["(existingFilters: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[], filters: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[], comparatorOptions?: ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.FilterCompareOptions","text":"FilterCompareOptions"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]"],"description":["\nCombine 2 filter collections, removing duplicates\n"],"label":"dedupFilters","source":{"path":"src/plugins/data/common/query/filter_manager/dedup_filters.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/dedup_filters.ts#L22"},"returnComment":["An array of filters that were not in existing"],"initialIsOpen":false},{"id":"def-common.uniqFilters","type":"Function","children":[{"type":"Array","label":"filters","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]"],"description":[],"source":{"path":"src/plugins/data/common/query/filter_manager/uniq_filters.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/uniq_filters.ts#L21"}},{"type":"Any","label":"comparatorOptions","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/query/filter_manager/uniq_filters.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/uniq_filters.ts#L21"}}],"signature":["(filters: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[], comparatorOptions?: any) => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]"],"description":["\nRemove duplicate filters from an array of filters\n"],"label":"uniqFilters","source":{"path":"src/plugins/data/common/query/filter_manager/uniq_filters.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/uniq_filters.ts#L21"},"returnComment":["The original filters array with duplicates removed"],"initialIsOpen":false},{"id":"def-common.compareFilters","type":"Function","children":[{"type":"CompoundType","label":"first","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]"],"description":[],"source":{"path":"src/plugins/data/common/query/filter_manager/compare_filters.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L65"}},{"type":"CompoundType","label":"second","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[]"],"description":[],"source":{"path":"src/plugins/data/common/query/filter_manager/compare_filters.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L66"}},{"type":"Object","label":"comparatorOptions","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.FilterCompareOptions","text":"FilterCompareOptions"}],"description":[],"source":{"path":"src/plugins/data/common/query/filter_manager/compare_filters.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L67"}}],"signature":["(first: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[], second: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[], comparatorOptions?: ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.FilterCompareOptions","text":"FilterCompareOptions"}],"description":["\nCompare two filters or filter arrays to see if they match.\nFor filter arrays, the assumption is they are sorted.\n"],"label":"compareFilters","source":{"path":"src/plugins/data/common/query/filter_manager/compare_filters.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L64"},"returnComment":["Filters are the same"],"initialIsOpen":false},{"id":"def-common.calculateBounds","type":"Function","label":"calculateBounds","signature":["(timeRange: ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"},", options: CalculateBoundsOptions) => ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRangeBounds","text":"TimeRangeBounds"}],"description":[],"children":[{"type":"Object","label":"timeRange","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"}],"description":[],"source":{"path":"src/plugins/data/common/query/timefilter/get_time.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L17"}},{"type":"Object","label":"options","isRequired":true,"signature":["CalculateBoundsOptions"],"description":[],"source":{"path":"src/plugins/data/common/query/timefilter/get_time.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L18"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/query/timefilter/get_time.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L16"},"initialIsOpen":false},{"id":"def-common.getAbsoluteTimeRange","type":"Function","label":"getAbsoluteTimeRange","signature":["(timeRange: ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"},", { forceNow }: { forceNow?: Date | undefined; }) => ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"}],"description":[],"children":[{"type":"Object","label":"timeRange","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"}],"description":[],"source":{"path":"src/plugins/data/common/query/timefilter/get_time.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L27"}},{"id":"def-common.getAbsoluteTimeRange.{-forceNow }","type":"Object","label":"{ forceNow }","description":[],"children":[{"id":"def-common.getAbsoluteTimeRange.{-forceNow }.forceNow","type":"Object","label":"forceNow","description":[],"source":{"path":"src/plugins/data/common/query/timefilter/get_time.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L28"},"signature":["Date | undefined"]}],"source":{"path":"src/plugins/data/common/query/timefilter/get_time.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L28"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/query/timefilter/get_time.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L26"},"initialIsOpen":false},{"id":"def-common.getTime","type":"Function","label":"getTime","signature":["(indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"}," | undefined, timeRange: ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"},", options: { forceNow?: Date | undefined; fieldName?: string | undefined; } | undefined) => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.RangeFilter","text":"RangeFilter"}," | undefined"],"description":[],"children":[{"type":"Object","label":"indexPattern","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/query/timefilter/get_time.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L38"}},{"type":"Object","label":"timeRange","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"}],"description":[],"source":{"path":"src/plugins/data/common/query/timefilter/get_time.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L39"}},{"id":"def-common.getTime.options","type":"Object","label":"options","description":[],"children":[{"id":"def-common.getTime.options.forceNow","type":"Object","label":"forceNow","description":[],"source":{"path":"src/plugins/data/common/query/timefilter/get_time.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L40"},"signature":["Date | undefined"]},{"id":"def-common.getTime.options.fieldName","type":"string","label":"fieldName","description":[],"source":{"path":"src/plugins/data/common/query/timefilter/get_time.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L40"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/data/common/query/timefilter/get_time.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L40"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/query/timefilter/get_time.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/get_time.ts#L37"},"initialIsOpen":false},{"id":"def-common.isTimeRange","type":"Function","children":[{"type":"Unknown","label":"x","isRequired":true,"signature":["unknown"],"description":[],"source":{"path":"src/plugins/data/common/query/timefilter/is_time_range.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/is_time_range.ts#L11"}}],"signature":["(x: unknown) => x is ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"}],"description":[],"label":"isTimeRange","source":{"path":"src/plugins/data/common/query/timefilter/is_time_range.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/is_time_range.ts#L11"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.isQuery","type":"Function","children":[{"type":"Unknown","label":"x","isRequired":true,"signature":["unknown"],"description":[],"source":{"path":"src/plugins/data/common/query/is_query.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/is_query.ts#L11"}}],"signature":["(x: unknown) => x is ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.Query","text":"Query"}],"description":[],"label":"isQuery","source":{"path":"src/plugins/data/common/query/is_query.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/is_query.ts#L11"},"returnComment":[],"initialIsOpen":false}],"interfaces":[{"id":"def-common.FilterCompareOptions","type":"Interface","label":"FilterCompareOptions","description":[],"children":[{"id":"def-common.FilterCompareOptions.index","type":"CompoundType","label":"index","description":[],"source":{"path":"src/plugins/data/common/query/filter_manager/compare_filters.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L13"},"signature":["boolean | undefined"]},{"id":"def-common.FilterCompareOptions.disabled","type":"CompoundType","label":"disabled","description":[],"source":{"path":"src/plugins/data/common/query/filter_manager/compare_filters.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L14"},"signature":["boolean | undefined"]},{"id":"def-common.FilterCompareOptions.negate","type":"CompoundType","label":"negate","description":[],"source":{"path":"src/plugins/data/common/query/filter_manager/compare_filters.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L15"},"signature":["boolean | undefined"]},{"id":"def-common.FilterCompareOptions.state","type":"CompoundType","label":"state","description":[],"source":{"path":"src/plugins/data/common/query/filter_manager/compare_filters.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L16"},"signature":["boolean | undefined"]},{"id":"def-common.FilterCompareOptions.alias","type":"CompoundType","label":"alias","description":[],"source":{"path":"src/plugins/data/common/query/filter_manager/compare_filters.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L17"},"signature":["boolean | undefined"]}],"source":{"path":"src/plugins/data/common/query/filter_manager/compare_filters.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L12"},"initialIsOpen":false},{"id":"def-common.RefreshInterval","type":"Interface","label":"RefreshInterval","description":[],"children":[{"id":"def-common.RefreshInterval.pause","type":"boolean","label":"pause","description":[],"source":{"path":"src/plugins/data/common/query/timefilter/types.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L12"}},{"id":"def-common.RefreshInterval.value","type":"number","label":"value","description":[],"source":{"path":"src/plugins/data/common/query/timefilter/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L13"}}],"source":{"path":"src/plugins/data/common/query/timefilter/types.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L11"},"initialIsOpen":false},{"id":"def-common.TimeRangeBounds","type":"Interface","label":"TimeRangeBounds","description":[],"children":[{"id":"def-common.TimeRangeBounds.min","type":"Object","label":"min","description":[],"source":{"path":"src/plugins/data/common/query/timefilter/types.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L24"},"signature":["moment.Moment | undefined"]},{"id":"def-common.TimeRangeBounds.max","type":"Object","label":"max","description":[],"source":{"path":"src/plugins/data/common/query/timefilter/types.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L25"},"signature":["moment.Moment | undefined"]}],"source":{"path":"src/plugins/data/common/query/timefilter/types.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L23"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-common.Query","type":"Type","label":"Query","description":[],"source":{"path":"src/plugins/data/common/query/types.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/types.ts#L12"},"signature":["{ query: string | { [key: string]: any; }; language: string; }"],"initialIsOpen":false},{"id":"def-common.TimeRange","type":"Type","label":"TimeRange","description":[],"source":{"path":"src/plugins/data/common/query/timefilter/types.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/timefilter/types.ts#L17"},"signature":["{ from: string; to: string; mode?: \"absolute\" | \"relative\" | undefined; }"],"initialIsOpen":false}],"objects":[{"id":"def-common.COMPARE_ALL_OPTIONS","type":"Object","children":[{"id":"def-common.COMPARE_ALL_OPTIONS.index","type":"boolean","label":"index","description":[],"source":{"path":"src/plugins/data/common/query/filter_manager/compare_filters.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L24"},"signature":["true"]},{"id":"def-common.COMPARE_ALL_OPTIONS.disabled","type":"boolean","label":"disabled","description":[],"source":{"path":"src/plugins/data/common/query/filter_manager/compare_filters.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L25"},"signature":["true"]},{"id":"def-common.COMPARE_ALL_OPTIONS.negate","type":"boolean","label":"negate","description":[],"source":{"path":"src/plugins/data/common/query/filter_manager/compare_filters.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L26"},"signature":["true"]},{"id":"def-common.COMPARE_ALL_OPTIONS.state","type":"boolean","label":"state","description":[],"source":{"path":"src/plugins/data/common/query/filter_manager/compare_filters.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L27"},"signature":["true"]},{"id":"def-common.COMPARE_ALL_OPTIONS.alias","type":"boolean","label":"alias","description":[],"source":{"path":"src/plugins/data/common/query/filter_manager/compare_filters.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L28"},"signature":["true"]}],"description":["\nInclude disabled, negate and store when comparing filters"],"label":"COMPARE_ALL_OPTIONS","source":{"path":"src/plugins/data/common/query/filter_manager/compare_filters.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/query/filter_manager/compare_filters.ts#L23"},"initialIsOpen":false}]}} \ No newline at end of file diff --git a/api_docs/data_query.mdx b/api_docs/data_query.mdx new file mode 100644 index 0000000000000..7a13675f71c57 --- /dev/null +++ b/api_docs/data_query.mdx @@ -0,0 +1,32 @@ +--- +id: kibDataQueryPluginApi +slug: /kibana-dev-docs/data.queryPluginApi +title: data.query +image: https://source.unsplash.com/400x175/?github +summary: API docs for the data.query plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.query'] +--- + +import dataQueryObj from './data_query.json'; + +## Client + +### Functions + +### Classes + +### Interfaces + +### Consts, variables and types + +## Common + +### Objects + +### Functions + +### Interfaces + +### Consts, variables and types + diff --git a/api_docs/data_search.json b/api_docs/data_search.json new file mode 100644 index 0000000000000..f1806cfac3db0 --- /dev/null +++ b/api_docs/data_search.json @@ -0,0 +1 @@ +{"id":"data.search","client":{"classes":[{"id":"def-public.SearchInterceptor","type":"Class","label":"SearchInterceptor","description":[],"children":[{"id":"def-public.SearchInterceptor.abortController","type":"Object","label":"abortController","description":["\n`abortController` used to signal all searches to abort."],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L50"},"signature":["AbortController"]},{"id":"def-public.SearchInterceptor.pendingCount$","type":"Object","label":"pendingCount$","description":["\nObservable that emits when the number of pending requests changes."],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L56"},"signature":["BehaviorSubject",""]},{"id":"def-public.SearchInterceptor.application","type":"Object","label":"application","description":[],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L61"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.ApplicationStart","text":"ApplicationStart"}]},{"id":"def-public.SearchInterceptor.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"deps","isRequired":true,"signature":[{"pluginId":"data","scope":"public","docId":"kibDataSearchPluginApi","section":"def-public.SearchInterceptorDeps","text":"SearchInterceptorDeps"}],"description":[],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L70"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L70"}},{"id":"def-public.SearchInterceptor.getTimeoutMode","type":"Function","label":"getTimeoutMode","signature":["() => ",{"pluginId":"data","scope":"public","docId":"kibDataSearchPluginApi","section":"def-public.TimeoutErrorMode","text":"TimeoutErrorMode"}],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L86"}},{"id":"def-public.SearchInterceptor.handleSearchError","type":"Function","label":"handleSearchError","signature":["(e: ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.KibanaServerError","text":"KibanaServerError"}," | ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.AbortError","text":"AbortError"},", timeoutSignal: AbortSignal, options?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"}," | undefined) => Error"],"description":[],"children":[{"type":"CompoundType","label":"e","isRequired":true,"signature":[{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.KibanaServerError","text":"KibanaServerError"}," | ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.AbortError","text":"AbortError"}],"description":[],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L95"}},{"type":"Object","label":"timeoutSignal","isRequired":true,"signature":["AbortSignal"],"description":[],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L96"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L97"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L94"}},{"id":"def-public.SearchInterceptor.runSearch","type":"Function","label":"runSearch","signature":["(request: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IKibanaSearchRequest","text":"IKibanaSearchRequest"},", options?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"}," | undefined) => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IKibanaSearchResponse","text":"IKibanaSearchResponse"},">"],"description":[],"children":[{"type":"Object","label":"request","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IKibanaSearchRequest","text":"IKibanaSearchRequest"},""],"description":[],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":126,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L126"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":127,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L127"}}],"tags":["internal","throws"],"returnComment":[],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":125,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L125"}},{"id":"def-public.SearchInterceptor.setupAbortSignal","type":"Function","label":"setupAbortSignal","signature":["({ abortSignal, timeout, }: { abortSignal?: AbortSignal | undefined; timeout?: number | undefined; }) => { timeoutSignal: AbortSignal; combinedSignal: AbortSignal; cleanup: () => void; abort: () => void; }"],"description":[],"children":[{"id":"def-public.SearchInterceptor.setupAbortSignal.{\n- abortSignal,\n timeout,\n }","type":"Object","label":"{\n abortSignal,\n timeout,\n }","description":[],"children":[{"id":"def-public.SearchInterceptor.setupAbortSignal.{\n- abortSignal,\n timeout,\n }.abortSignal","type":"Object","label":"abortSignal","description":[],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":150,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L150"},"signature":["AbortSignal | undefined"]},{"id":"def-public.SearchInterceptor.setupAbortSignal.{\n- abortSignal,\n timeout,\n }.timeout","type":"number","label":"timeout","description":[],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":151,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L151"},"signature":["number | undefined"]}],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":149,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L149"}}],"tags":["internal"],"returnComment":[],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":146,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L146"}},{"id":"def-public.SearchInterceptor.search","type":"Function","label":"search","signature":["(request: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IKibanaSearchRequest","text":"IKibanaSearchRequest"},", options?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"}," | undefined) => ","Observable","<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IKibanaSearchResponse","text":"IKibanaSearchResponse"},">"],"description":["\nSearches using the given `search` method. Overrides the `AbortSignal` with one that will abort\neither when the request times out, or when the original `AbortSignal` is aborted. Updates\n`pendingCount$` when the request is started/finalized.\n"],"children":[{"type":"Object","label":"request","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IKibanaSearchRequest","text":"IKibanaSearchRequest"},""],"description":[],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":233,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L233"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":234,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L234"}}],"tags":["options"],"returnComment":["`Observable` emitting the search response or an error."],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":232,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L232"}},{"id":"def-public.SearchInterceptor.showError","type":"Function","label":"showError","signature":["(e: Error) => void"],"description":[],"children":[{"type":"Object","label":"e","isRequired":true,"signature":["Error"],"description":[],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":261,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L261"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":261,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L261"}}],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L45"},"initialIsOpen":false},{"id":"def-public.SearchTimeoutError","type":"Class","label":"SearchTimeoutError","description":["\nRequest Failure - When an entire multi request fails"],"signature":[{"pluginId":"data","scope":"public","docId":"kibDataSearchPluginApi","section":"def-public.SearchTimeoutError","text":"SearchTimeoutError"}," extends ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.KbnError","text":"KbnError"}],"children":[{"id":"def-public.SearchTimeoutError.mode","type":"Enum","label":"mode","description":[],"source":{"path":"src/plugins/data/public/search/errors/timeout_error.tsx","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/timeout_error.tsx#L26"},"signature":[{"pluginId":"data","scope":"public","docId":"kibDataSearchPluginApi","section":"def-public.TimeoutErrorMode","text":"TimeoutErrorMode"}]},{"id":"def-public.SearchTimeoutError.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"err","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/data/public/search/errors/timeout_error.tsx","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/timeout_error.tsx#L27"}},{"type":"Enum","label":"mode","isRequired":true,"signature":[{"pluginId":"data","scope":"public","docId":"kibDataSearchPluginApi","section":"def-public.TimeoutErrorMode","text":"TimeoutErrorMode"}],"description":[],"source":{"path":"src/plugins/data/public/search/errors/timeout_error.tsx","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/timeout_error.tsx#L27"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/search/errors/timeout_error.tsx","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/timeout_error.tsx#L27"}},{"id":"def-public.SearchTimeoutError.getErrorMessage","type":"Function","label":"getErrorMessage","signature":["(application: ",{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.ApplicationStart","text":"ApplicationStart"},") => JSX.Element"],"description":[],"children":[{"type":"Object","label":"application","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.ApplicationStart","text":"ApplicationStart"}],"description":[],"source":{"path":"src/plugins/data/public/search/errors/timeout_error.tsx","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/timeout_error.tsx#L80"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/search/errors/timeout_error.tsx","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/timeout_error.tsx#L80"}}],"source":{"path":"src/plugins/data/public/search/errors/timeout_error.tsx","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/timeout_error.tsx#L25"},"initialIsOpen":false},{"id":"def-public.PainlessError","type":"Class","label":"PainlessError","description":[],"signature":[{"pluginId":"data","scope":"public","docId":"kibDataSearchPluginApi","section":"def-public.PainlessError","text":"PainlessError"}," extends ","EsError"],"children":[{"id":"def-public.PainlessError.painlessStack","type":"string","label":"painlessStack","description":[],"source":{"path":"src/plugins/data/public/search/errors/painless_error.tsx","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/painless_error.tsx#L20"},"signature":["string | undefined"]},{"id":"def-public.PainlessError.indexPattern","type":"Object","label":"indexPattern","description":[],"source":{"path":"src/plugins/data/public/search/errors/painless_error.tsx","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/painless_error.tsx#L21"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}," | undefined"]},{"id":"def-public.PainlessError.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"err","isRequired":true,"signature":[{"pluginId":"data","scope":"public","docId":"kibDataSearchPluginApi","section":"def-public.IEsError","text":"IEsError"}],"description":[],"source":{"path":"src/plugins/data/public/search/errors/painless_error.tsx","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/painless_error.tsx#L22"}},{"type":"Object","label":"indexPattern","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/public/search/errors/painless_error.tsx","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/painless_error.tsx#L22"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/search/errors/painless_error.tsx","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/painless_error.tsx#L22"}},{"id":"def-public.PainlessError.getErrorMessage","type":"Function","label":"getErrorMessage","signature":["(application: ",{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.ApplicationStart","text":"ApplicationStart"},") => JSX.Element"],"description":[],"children":[{"type":"Object","label":"application","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.ApplicationStart","text":"ApplicationStart"}],"description":[],"source":{"path":"src/plugins/data/public/search/errors/painless_error.tsx","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/painless_error.tsx#L27"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/search/errors/painless_error.tsx","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/painless_error.tsx#L27"}}],"source":{"path":"src/plugins/data/public/search/errors/painless_error.tsx","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/painless_error.tsx#L19"},"initialIsOpen":false}],"functions":[{"id":"def-public.getEsPreference","type":"Function","label":"getEsPreference","signature":["(uiSettings: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.IUiSettingsClient","text":"IUiSettingsClient"},", sessionId: string) => any"],"description":[],"children":[{"type":"Object","label":"uiSettings","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.IUiSettingsClient","text":"IUiSettingsClient"}],"description":[],"source":{"path":"src/plugins/data/public/search/es_search/get_es_preference.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/es_search/get_es_preference.ts#L14"}},{"type":"string","label":"sessionId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/public/search/es_search/get_es_preference.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/es_search/get_es_preference.ts#L14"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/public/search/es_search/get_es_preference.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/es_search/get_es_preference.ts#L14"},"initialIsOpen":false}],"interfaces":[{"id":"def-public.ISearchSetup","type":"Interface","label":"ISearchSetup","description":["\nThe setup contract exposed by the Search plugin exposes the search strategy extension\npoint."],"children":[{"id":"def-public.ISearchSetup.aggs","type":"Object","label":"aggs","description":[],"source":{"path":"src/plugins/data/public/search/types.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/types.ts#L29"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggsCommonSetup","text":"AggsCommonSetup"}]},{"id":"def-public.ISearchSetup.usageCollector","type":"Object","label":"usageCollector","description":[],"source":{"path":"src/plugins/data/public/search/types.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/types.ts#L30"},"signature":[{"pluginId":"data","scope":"public","docId":"kibDataSearchPluginApi","section":"def-public.SearchUsageCollector","text":"SearchUsageCollector"}," | undefined"]},{"id":"def-public.ISearchSetup.session","type":"Object","label":"session","description":["\nCurrent session management\n{@link ISessionService}"],"source":{"path":"src/plugins/data/public/search/types.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/types.ts#L35"},"signature":["Pick<",{"pluginId":"data","scope":"public","docId":"kibDataSearchPluginApi","section":"def-public.SessionService","text":"SessionService"},", \"start\" | \"destroy\" | \"state$\" | \"hasAccess\" | \"trackSearch\" | \"getSessionId\" | \"getSession$\" | \"isStored\" | \"isRestore\" | \"restore\" | \"clear\" | \"cancel\" | \"save\" | \"isCurrentSession\" | \"getSearchOptions\" | \"enableStorage\" | \"isSessionStorageReady\" | \"getSearchSessionIndicatorUiConfig\">"]},{"id":"def-public.ISearchSetup.sessionsClient","type":"Object","label":"sessionsClient","description":["\nSearch sessions SO CRUD\n{@link ISessionsClient}"],"source":{"path":"src/plugins/data/public/search/types.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/types.ts#L40"},"signature":["Pick<",{"pluginId":"data","scope":"public","docId":"kibDataSearchPluginApi","section":"def-public.SessionsClient","text":"SessionsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"extend\">"]},{"id":"def-public.ISearchSetup.__enhance","type":"Function","label":"__enhance","description":[],"source":{"path":"src/plugins/data/public/search/types.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/types.ts#L44"},"signature":["(enhancements: ",{"pluginId":"data","scope":"public","docId":"kibDataSearchPluginApi","section":"def-public.SearchEnhancements","text":"SearchEnhancements"},") => void"]}],"source":{"path":"src/plugins/data/public/search/types.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/types.ts#L28"},"initialIsOpen":false},{"id":"def-public.ISearchStart","type":"Interface","label":"ISearchStart","description":["\nsearch service"],"children":[{"id":"def-public.ISearchStart.aggs","type":"Object","label":"aggs","description":["\nagg config sub service\n{@link AggsStart}\n"],"source":{"path":"src/plugins/data/public/search/types.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/types.ts#L57"},"signature":["Pick & Pick<{ types: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggTypesRegistryStart","text":"AggTypesRegistryStart"},"; }, \"types\"> & Pick<{ types: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggTypesRegistryStart","text":"AggTypesRegistryStart"},"; }, never>, \"calculateAutoTimeExpression\" | \"getDateMetaByDatatableColumn\" | \"datatableUtilities\" | \"createAggConfigs\" | \"types\">"]},{"id":"def-public.ISearchStart.search","type":"Function","label":"search","description":["\nlow level search\n{@link ISearchGeneric}"],"source":{"path":"src/plugins/data/public/search/types.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/types.ts#L62"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchGeneric","text":"ISearchGeneric"}]},{"id":"def-public.ISearchStart.showError","type":"Function","label":"showError","description":[],"source":{"path":"src/plugins/data/public/search/types.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/types.ts#L64"},"signature":["(e: Error) => void"]},{"id":"def-public.ISearchStart.searchSource","type":"Object","label":"searchSource","description":["\nhigh level search\n{@link ISearchStartSearchSource}"],"source":{"path":"src/plugins/data/public/search/types.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/types.ts#L69"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchStartSearchSource","text":"ISearchStartSearchSource"}]},{"id":"def-public.ISearchStart.session","type":"Object","label":"session","description":["\nCurrent session management\n{@link ISessionService}"],"source":{"path":"src/plugins/data/public/search/types.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/types.ts#L74"},"signature":["Pick<",{"pluginId":"data","scope":"public","docId":"kibDataSearchPluginApi","section":"def-public.SessionService","text":"SessionService"},", \"start\" | \"destroy\" | \"state$\" | \"hasAccess\" | \"trackSearch\" | \"getSessionId\" | \"getSession$\" | \"isStored\" | \"isRestore\" | \"restore\" | \"clear\" | \"cancel\" | \"save\" | \"isCurrentSession\" | \"getSearchOptions\" | \"enableStorage\" | \"isSessionStorageReady\" | \"getSearchSessionIndicatorUiConfig\">"]},{"id":"def-public.ISearchStart.sessionsClient","type":"Object","label":"sessionsClient","description":["\nSearch sessions SO CRUD\n{@link ISessionsClient}"],"source":{"path":"src/plugins/data/public/search/types.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/types.ts#L79"},"signature":["Pick<",{"pluginId":"data","scope":"public","docId":"kibDataSearchPluginApi","section":"def-public.SessionsClient","text":"SessionsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"extend\">"]}],"source":{"path":"src/plugins/data/public/search/types.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/types.ts#L51"},"initialIsOpen":false},{"id":"def-public.SearchInterceptorDeps","type":"Interface","label":"SearchInterceptorDeps","description":[],"children":[{"id":"def-public.SearchInterceptorDeps.bfetch","type":"Object","label":"bfetch","description":[],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L36"},"signature":[{"pluginId":"bfetch","scope":"public","docId":"kibBfetchPluginApi","section":"def-public.BfetchPublicContract","text":"BfetchPublicContract"}]},{"id":"def-public.SearchInterceptorDeps.http","type":"Object","label":"http","description":[],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L37"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpSetup","text":"HttpSetup"}]},{"id":"def-public.SearchInterceptorDeps.uiSettings","type":"Object","label":"uiSettings","description":[],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L38"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.IUiSettingsClient","text":"IUiSettingsClient"}]},{"id":"def-public.SearchInterceptorDeps.startServices","type":"Object","label":"startServices","description":[],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L39"},"signature":["Promise<[",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreStart","text":"CoreStart"},", any, unknown]>"]},{"id":"def-public.SearchInterceptorDeps.toasts","type":"Object","label":"toasts","description":[],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L40"},"signature":["Pick<",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastsApi","text":"ToastsApi"},", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">"]},{"id":"def-public.SearchInterceptorDeps.usageCollector","type":"Object","label":"usageCollector","description":[],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L41"},"signature":[{"pluginId":"data","scope":"public","docId":"kibDataSearchPluginApi","section":"def-public.SearchUsageCollector","text":"SearchUsageCollector"}," | undefined"]},{"id":"def-public.SearchInterceptorDeps.session","type":"Object","label":"session","description":[],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L42"},"signature":["Pick<",{"pluginId":"data","scope":"public","docId":"kibDataSearchPluginApi","section":"def-public.SessionService","text":"SessionService"},", \"start\" | \"destroy\" | \"state$\" | \"hasAccess\" | \"trackSearch\" | \"getSessionId\" | \"getSession$\" | \"isStored\" | \"isRestore\" | \"restore\" | \"clear\" | \"cancel\" | \"save\" | \"isCurrentSession\" | \"getSearchOptions\" | \"enableStorage\" | \"isSessionStorageReady\" | \"getSearchSessionIndicatorUiConfig\">"]}],"source":{"path":"src/plugins/data/public/search/search_interceptor.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/search_interceptor.ts#L35"},"initialIsOpen":false},{"id":"def-public.SearchSessionInfoProvider","type":"Interface","label":"SearchSessionInfoProvider","signature":[{"pluginId":"data","scope":"public","docId":"kibDataSearchPluginApi","section":"def-public.SearchSessionInfoProvider","text":"SearchSessionInfoProvider"},""],"description":["\nProvide info about current search session to be stored in the Search Session saved object"],"children":[{"id":"def-public.SearchSessionInfoProvider.getName","type":"Function","label":"getName","description":["\nUser-facing name of the session.\ne.g. will be displayed in saved Search Sessions management list"],"source":{"path":"src/plugins/data/public/search/session/session_service.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/session/session_service.ts#L39"},"signature":["() => Promise"]},{"id":"def-public.SearchSessionInfoProvider.getUrlGeneratorData","type":"Function","label":"getUrlGeneratorData","description":[],"source":{"path":"src/plugins/data/public/search/session/session_service.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/session/session_service.ts#L40"},"signature":["() => Promise<{ urlGeneratorId: ID; initialState: ",{"pluginId":"share","scope":"public","docId":"kibSharePluginApi","section":"def-public.UrlGeneratorStateMapping","text":"UrlGeneratorStateMapping"},"[ID][\"State\"]; restoreState: ",{"pluginId":"share","scope":"public","docId":"kibSharePluginApi","section":"def-public.UrlGeneratorStateMapping","text":"UrlGeneratorStateMapping"},"[ID][\"State\"]; }>"]}],"source":{"path":"src/plugins/data/public/search/session/session_service.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/session/session_service.ts#L34"},"initialIsOpen":false},{"id":"def-public.SearchUsageCollector","type":"Interface","label":"SearchUsageCollector","description":[],"children":[{"id":"def-public.SearchUsageCollector.trackQueryTimedOut","type":"Function","label":"trackQueryTimedOut","description":[],"source":{"path":"src/plugins/data/public/search/collectors/types.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/collectors/types.ts#L75"},"signature":["() => Promise"]},{"id":"def-public.SearchUsageCollector.trackSessionIndicatorTourLoading","type":"Function","label":"trackSessionIndicatorTourLoading","description":[],"source":{"path":"src/plugins/data/public/search/collectors/types.ts","lineNumber":76,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/collectors/types.ts#L76"},"signature":["() => Promise"]},{"id":"def-public.SearchUsageCollector.trackSessionIndicatorTourRestored","type":"Function","label":"trackSessionIndicatorTourRestored","description":[],"source":{"path":"src/plugins/data/public/search/collectors/types.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/collectors/types.ts#L77"},"signature":["() => Promise"]},{"id":"def-public.SearchUsageCollector.trackSessionIndicatorSaveDisabled","type":"Function","label":"trackSessionIndicatorSaveDisabled","description":[],"source":{"path":"src/plugins/data/public/search/collectors/types.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/collectors/types.ts#L78"},"signature":["() => Promise"]},{"id":"def-public.SearchUsageCollector.trackSessionSentToBackground","type":"Function","label":"trackSessionSentToBackground","description":[],"source":{"path":"src/plugins/data/public/search/collectors/types.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/collectors/types.ts#L79"},"signature":["() => Promise"]},{"id":"def-public.SearchUsageCollector.trackSessionSavedResults","type":"Function","label":"trackSessionSavedResults","description":[],"source":{"path":"src/plugins/data/public/search/collectors/types.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/collectors/types.ts#L80"},"signature":["() => Promise"]},{"id":"def-public.SearchUsageCollector.trackSessionViewRestored","type":"Function","label":"trackSessionViewRestored","description":[],"source":{"path":"src/plugins/data/public/search/collectors/types.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/collectors/types.ts#L81"},"signature":["() => Promise"]},{"id":"def-public.SearchUsageCollector.trackSessionIsRestored","type":"Function","label":"trackSessionIsRestored","description":[],"source":{"path":"src/plugins/data/public/search/collectors/types.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/collectors/types.ts#L82"},"signature":["() => Promise"]},{"id":"def-public.SearchUsageCollector.trackSessionReloaded","type":"Function","label":"trackSessionReloaded","description":[],"source":{"path":"src/plugins/data/public/search/collectors/types.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/collectors/types.ts#L83"},"signature":["() => Promise"]},{"id":"def-public.SearchUsageCollector.trackSessionExtended","type":"Function","label":"trackSessionExtended","description":[],"source":{"path":"src/plugins/data/public/search/collectors/types.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/collectors/types.ts#L84"},"signature":["() => Promise"]},{"id":"def-public.SearchUsageCollector.trackSessionCancelled","type":"Function","label":"trackSessionCancelled","description":[],"source":{"path":"src/plugins/data/public/search/collectors/types.ts","lineNumber":85,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/collectors/types.ts#L85"},"signature":["() => Promise"]},{"id":"def-public.SearchUsageCollector.trackSessionDeleted","type":"Function","label":"trackSessionDeleted","description":[],"source":{"path":"src/plugins/data/public/search/collectors/types.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/collectors/types.ts#L86"},"signature":["() => Promise"]},{"id":"def-public.SearchUsageCollector.trackViewSessionsList","type":"Function","label":"trackViewSessionsList","description":[],"source":{"path":"src/plugins/data/public/search/collectors/types.ts","lineNumber":87,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/collectors/types.ts#L87"},"signature":["() => Promise"]},{"id":"def-public.SearchUsageCollector.trackSessionsListLoaded","type":"Function","label":"trackSessionsListLoaded","description":[],"source":{"path":"src/plugins/data/public/search/collectors/types.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/collectors/types.ts#L88"},"signature":["() => Promise"]}],"source":{"path":"src/plugins/data/public/search/collectors/types.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/collectors/types.ts#L74"},"initialIsOpen":false}],"enums":[{"id":"def-public.SearchSessionState","type":"Enum","label":"SearchSessionState","description":["\nPossible state that current session can be in\n"],"source":{"path":"src/plugins/data/public/search/session/search_session_state.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/session/search_session_state.ts#L19"},"initialIsOpen":false},{"id":"def-public.TimeoutErrorMode","type":"Enum","label":"TimeoutErrorMode","description":[],"source":{"path":"src/plugins/data/public/search/errors/timeout_error.tsx","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/errors/timeout_error.tsx#L15"},"initialIsOpen":false}],"misc":[{"id":"def-public.EsdslExpressionFunctionDefinition","type":"Type","label":"EsdslExpressionFunctionDefinition","description":[],"source":{"path":"src/plugins/data/public/search/expressions/esdsl.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/expressions/esdsl.ts#L30"},"signature":["ExpressionFunctionDefinition<\"esdsl\", ",{"pluginId":"expressions","scope":"public","docId":"kibExpressionsPluginApi","section":"def-public.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"kibana_context\", ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ExecutionContextSearch","text":"ExecutionContextSearch"},"> | null, Arguments, Output, ",{"pluginId":"expressions","scope":"public","docId":"kibExpressionsPluginApi","section":"def-public.ExecutionContext","text":"ExecutionContext"},"<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializableState","text":"SerializableState"}],"initialIsOpen":false},{"id":"def-public.EsRawResponseExpressionTypeDefinition","type":"Type","label":"EsRawResponseExpressionTypeDefinition","description":[],"source":{"path":"src/plugins/data/public/search/expressions/es_raw_response.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/expressions/es_raw_response.ts#L57"},"signature":["ExpressionTypeDefinition<\"es_raw_response\", EsRawResponse, EsRawResponse>"],"initialIsOpen":false},{"id":"def-public.noSearchSessionStorageCapabilityMessage","type":"string","label":"noSearchSessionStorageCapabilityMessage","description":["\nMessage to display in case storing\nsession session is disabled due to turned off capability"],"source":{"path":"src/plugins/data/public/search/session/i18n.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/session/i18n.ts#L15"},"initialIsOpen":false},{"id":"def-public.SEARCH_SESSIONS_MANAGEMENT_ID","type":"string","label":"SEARCH_SESSIONS_MANAGEMENT_ID","description":[],"source":{"path":"src/plugins/data/public/search/session/constants.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/session/constants.ts#L9"},"signature":["\"search_sessions\""],"initialIsOpen":false},{"id":"def-public.ISessionService","type":"Type","label":"ISessionService","description":[],"source":{"path":"src/plugins/data/public/search/session/session_service.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/session/session_service.ts#L25"},"signature":["{ start: () => string; destroy: () => void; readonly state$: Observable; hasAccess: () => boolean; trackSearch: (searchDescriptor: TrackSearchDescriptor) => () => void; getSessionId: () => string | undefined; getSession$: () => Observable; isStored: () => boolean; isRestore: () => boolean; restore: (sessionId: string) => void; clear: () => void; cancel: () => Promise; save: () => Promise; isCurrentSession: (sessionId?: string | undefined) => boolean; getSearchOptions: (sessionId?: string | undefined) => Required> | null; enableStorage: (searchSessionInfoProvider: SearchSessionInfoProvider, searchSessionIndicatorUiConfig?: SearchSessionIndicatorUiConfig | undefined) => void; isSessionStorageReady: () => boolean; getSearchSessionIndicatorUiConfig: () => SearchSessionIndicatorUiConfig; }"],"initialIsOpen":false},{"id":"def-public.ISessionsClient","type":"Type","label":"ISessionsClient","description":[],"source":{"path":"src/plugins/data/public/search/session/sessions_client.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/search/session/sessions_client.ts#L13"},"signature":["{ get: (sessionId: string) => Promise>; delete: (sessionId: string) => Promise; create: ({ name, appId, urlGeneratorId, initialState, restoreState, sessionId, }: { name: string; appId: string; initialState: Record; restoreState: Record; urlGeneratorId: string; sessionId: string; }) => Promise>; find: (options: Pick) => Promise>; update: (sessionId: string, attributes: unknown) => Promise>; extend: (sessionId: string, expires: string) => Promise>; }"],"initialIsOpen":false}],"objects":[]},"server":{"classes":[{"id":"def-server.SearchSessionService","type":"Class","label":"SearchSessionService","description":["\nThe OSS session service, which leaves most search session-related logic unimplemented."],"signature":[{"pluginId":"data","scope":"server","docId":"kibDataSearchPluginApi","section":"def-server.SearchSessionService","text":"SearchSessionService"}," implements ",{"pluginId":"data","scope":"server","docId":"kibDataSearchPluginApi","section":"def-server.ISearchSessionService","text":"ISearchSessionService"},""],"children":[{"id":"def-server.SearchSessionService.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/server/search/session/session_service.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/session/session_service.ts#L17"}},{"id":"def-server.SearchSessionService.asScopedProvider","type":"Function","label":"asScopedProvider","signature":["() => () => { getId: () => never; trackId: () => Promise; getSearchIdMapping: () => Promise>; save: () => Promise; get: () => Promise; find: () => Promise; update: () => Promise; extend: () => Promise; cancel: () => Promise; delete: () => Promise; }"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/server/search/session/session_service.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/session/session_service.ts#L19"}}],"source":{"path":"src/plugins/data/server/search/session/session_service.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/session/session_service.ts#L16"},"initialIsOpen":false}],"functions":[{"id":"def-server.getDefaultSearchParams","type":"Function","label":"getDefaultSearchParams","signature":["(uiSettingsClient: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.IUiSettingsClient","text":"IUiSettingsClient"},") => Promise>>, \"max_concurrent_shard_requests\" | \"ignore_unavailable\" | \"track_total_hits\">>"],"description":[],"children":[{"type":"Object","label":"uiSettingsClient","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.IUiSettingsClient","text":"IUiSettingsClient"}],"description":[],"source":{"path":"src/plugins/data/server/search/es_search/request_utils.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/es_search/request_utils.ts#L20"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/server/search/es_search/request_utils.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/es_search/request_utils.ts#L19"},"initialIsOpen":false},{"id":"def-server.getShardTimeout","type":"Function","label":"getShardTimeout","signature":["(config: Readonly<{ kibana: Readonly<{ readonly index: string; readonly autocompleteTerminateAfter: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly autocompleteTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; }>; elasticsearch: Readonly<{ readonly shardTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly requestTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly pingTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; }>; path: Readonly<{ readonly data: string; }>; savedObjects: Readonly<{ readonly maxImportPayloadBytes: Readonly<{ isGreaterThan: (other: ","ByteSizeValue",") => boolean; isLessThan: (other: ","ByteSizeValue",") => boolean; isEqualTo: (other: ","ByteSizeValue",") => boolean; getValueInBytes: () => number; toString: (returnUnit?: \"b\" | \"kb\" | \"mb\" | \"gb\" | undefined) => string; }>; }>; }>) => Pick<","Search","<","RequestBody"],"description":[],"children":[{"type":"Object","label":"config","isRequired":true,"signature":["Readonly<{ kibana: Readonly<{ readonly index: string; readonly autocompleteTerminateAfter: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly autocompleteTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; }>; elasticsearch: Readonly<{ readonly shardTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly requestTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; readonly pingTimeout: Readonly<{ clone: () => moment.Duration; humanize: { (argWithSuffix?: boolean | undefined, argThresholds?: moment.argThresholdOpts | undefined): string; (argThresholds?: moment.argThresholdOpts | undefined): string; }; abs: () => moment.Duration; as: (units: moment.unitOfTime.Base) => number; get: (units: moment.unitOfTime.Base) => number; milliseconds: () => number; asMilliseconds: () => number; seconds: () => number; asSeconds: () => number; minutes: () => number; asMinutes: () => number; hours: () => number; asHours: () => number; days: () => number; asDays: () => number; weeks: () => number; asWeeks: () => number; months: () => number; asMonths: () => number; years: () => number; asYears: () => number; add: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; subtract: (inp?: moment.DurationInputArg1, unit?: \"year\" | \"years\" | \"y\" | \"month\" | \"months\" | \"M\" | \"week\" | \"weeks\" | \"w\" | \"day\" | \"days\" | \"d\" | \"hour\" | \"hours\" | \"h\" | \"minute\" | \"minutes\" | \"m\" | \"second\" | \"seconds\" | \"s\" | \"millisecond\" | \"milliseconds\" | \"ms\" | \"quarter\" | \"quarters\" | \"Q\" | undefined) => moment.Duration; locale: { (): string; (locale: moment.LocaleSpecifier): moment.Duration; }; localeData: () => moment.Locale; toISOString: () => string; toJSON: () => string; isValid: () => boolean; lang: { (locale: moment.LocaleSpecifier): moment.Moment; (): moment.Locale; }; toIsoString: () => string; }>; }>; path: Readonly<{ readonly data: string; }>; savedObjects: Readonly<{ readonly maxImportPayloadBytes: Readonly<{ isGreaterThan: (other: ","ByteSizeValue",") => boolean; isLessThan: (other: ","ByteSizeValue",") => boolean; isEqualTo: (other: ","ByteSizeValue",") => boolean; getValueInBytes: () => number; toString: (returnUnit?: \"b\" | \"kb\" | \"mb\" | \"gb\" | undefined) => string; }>; }>; }>"],"description":[],"source":{"path":"src/plugins/data/server/search/es_search/request_utils.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/es_search/request_utils.ts#L14"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/server/search/es_search/request_utils.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/es_search/request_utils.ts#L14"},"initialIsOpen":false},{"id":"def-server.usageProvider","type":"Function","label":"usageProvider","signature":["(core: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreSetup","text":"CoreSetup"},") => ",{"pluginId":"data","scope":"server","docId":"kibDataSearchPluginApi","section":"def-server.SearchUsage","text":"SearchUsage"}],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreSetup","text":"CoreSetup"},""],"description":[],"source":{"path":"src/plugins/data/server/search/collectors/usage.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/collectors/usage.ts#L22"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/server/search/collectors/usage.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/collectors/usage.ts#L22"},"initialIsOpen":false},{"id":"def-server.searchUsageObserver","type":"Function","label":"searchUsageObserver","signature":["(logger: ","Logger",", usage: ",{"pluginId":"data","scope":"server","docId":"kibDataSearchPluginApi","section":"def-server.SearchUsage","text":"SearchUsage"}," | undefined) => { next(response: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IEsSearchResponse","text":"IEsSearchResponse"},"): void; error(): void; }"],"description":["\nRxjs observer for easily doing `tap(searchUsageObserver(logger, usage))` in an rxjs chain."],"children":[{"type":"Object","label":"logger","isRequired":true,"signature":["Logger"],"description":[],"source":{"path":"src/plugins/data/server/search/collectors/usage.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/collectors/usage.ts#L64"}},{"type":"Object","label":"usage","isRequired":false,"signature":[{"pluginId":"data","scope":"server","docId":"kibDataSearchPluginApi","section":"def-server.SearchUsage","text":"SearchUsage"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/server/search/collectors/usage.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/collectors/usage.ts#L64"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/server/search/collectors/usage.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/collectors/usage.ts#L64"},"initialIsOpen":false},{"id":"def-server.shimAbortSignal","type":"Function","children":[{"type":"Object","label":"promise","isRequired":true,"signature":["TransportRequestPromise",""],"description":[],"source":{"path":"src/plugins/data/server/search/es_search/request_utils.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/es_search/request_utils.ts#L41"}},{"type":"Object","label":"signal","isRequired":false,"signature":["AbortSignal | undefined"],"description":[],"source":{"path":"src/plugins/data/server/search/es_search/request_utils.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/es_search/request_utils.ts#L41"}}],"signature":["(promise: ","TransportRequestPromise",", signal?: AbortSignal | undefined) => ","TransportRequestPromise",""],"description":["\nTemporary workaround until https://github.com/elastic/elasticsearch-js/issues/1297 is resolved.\nShims the `AbortSignal` behavior so that, if the given `signal` aborts, the `abort` method on the\n`TransportRequestPromise` is called, actually performing the cancellation."],"label":"shimAbortSignal","source":{"path":"src/plugins/data/server/search/es_search/request_utils.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/es_search/request_utils.ts#L41"},"returnComment":[],"initialIsOpen":false}],"interfaces":[{"id":"def-server.ISearchStrategy","type":"Interface","label":"ISearchStrategy","signature":[{"pluginId":"data","scope":"server","docId":"kibDataSearchPluginApi","section":"def-server.ISearchStrategy","text":"ISearchStrategy"},""],"description":["\nSearch strategy interface contains a search method that takes in a request and returns a promise\nthat resolves to a response."],"children":[{"id":"def-server.ISearchStrategy.search","type":"Function","label":"search","description":[],"source":{"path":"src/plugins/data/server/search/types.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L75"},"signature":["(request: SearchStrategyRequest, options: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"},", deps: ",{"pluginId":"data","scope":"server","docId":"kibDataSearchPluginApi","section":"def-server.SearchStrategyDependencies","text":"SearchStrategyDependencies"},") => ","Observable",""]},{"id":"def-server.ISearchStrategy.cancel","type":"Function","label":"cancel","description":[],"source":{"path":"src/plugins/data/server/search/types.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L80"},"signature":["((id: string, options: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"},", deps: ",{"pluginId":"data","scope":"server","docId":"kibDataSearchPluginApi","section":"def-server.SearchStrategyDependencies","text":"SearchStrategyDependencies"},") => Promise) | undefined"]},{"id":"def-server.ISearchStrategy.extend","type":"Function","label":"extend","description":[],"source":{"path":"src/plugins/data/server/search/types.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L81"},"signature":["((id: string, keepAlive: string, options: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"},", deps: ",{"pluginId":"data","scope":"server","docId":"kibDataSearchPluginApi","section":"def-server.SearchStrategyDependencies","text":"SearchStrategyDependencies"},") => Promise) | undefined"]}],"source":{"path":"src/plugins/data/server/search/types.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L71"},"initialIsOpen":false},{"id":"def-server.ISearchSetup","type":"Interface","label":"ISearchSetup","description":[],"children":[{"id":"def-server.ISearchSetup.aggs","type":"Object","label":"aggs","description":[],"source":{"path":"src/plugins/data/server/search/types.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L43"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggsCommonSetup","text":"AggsCommonSetup"}]},{"id":"def-server.ISearchSetup.registerSearchStrategy","type":"Function","label":"registerSearchStrategy","description":["\nExtension point exposed for other plugins to register their own search\nstrategies."],"source":{"path":"src/plugins/data/server/search/types.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L48"},"signature":[" = ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IEsSearchRequest","text":"IEsSearchRequest"},", SearchStrategyResponse extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IKibanaSearchResponse","text":"IKibanaSearchResponse"}," = ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IEsSearchResponse","text":"IEsSearchResponse"},">(name: string, strategy: ",{"pluginId":"data","scope":"server","docId":"kibDataSearchPluginApi","section":"def-server.ISearchStrategy","text":"ISearchStrategy"}]},{"id":"def-server.ISearchSetup.usage","type":"Object","label":"usage","description":["\nUsed internally for telemetry"],"source":{"path":"src/plugins/data/server/search/types.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L59"},"signature":[{"pluginId":"data","scope":"server","docId":"kibDataSearchPluginApi","section":"def-server.SearchUsage","text":"SearchUsage"}," | undefined"]},{"id":"def-server.ISearchSetup.__enhance","type":"Function","label":"__enhance","description":[],"source":{"path":"src/plugins/data/server/search/types.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L64"},"signature":["(enhancements: ",{"pluginId":"data","scope":"server","docId":"kibDataSearchPluginApi","section":"def-server.SearchEnhancements","text":"SearchEnhancements"},") => void"]}],"source":{"path":"src/plugins/data/server/search/types.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L42"},"initialIsOpen":false},{"id":"def-server.ISearchStart","type":"Interface","label":"ISearchStart","signature":[{"pluginId":"data","scope":"server","docId":"kibDataSearchPluginApi","section":"def-server.ISearchStart","text":"ISearchStart"},""],"description":[],"children":[{"id":"def-server.ISearchStart.aggs","type":"Object","label":"aggs","description":[],"source":{"path":"src/plugins/data/server/search/types.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L103"},"signature":[{"pluginId":"data","scope":"server","docId":"kibDataSearchPluginApi","section":"def-server.AggsStart","text":"AggsStart"}]},{"id":"def-server.ISearchStart.getSearchStrategy","type":"Function","label":"getSearchStrategy","description":["\nGet other registered search strategies by name (or, by default, the Elasticsearch strategy).\nFor example, if a new strategy needs to use the already-registered ES search strategy, it can\nuse this function to accomplish that."],"source":{"path":"src/plugins/data/server/search/types.ts","lineNumber":109,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L109"},"signature":["(name?: string | undefined) => ",{"pluginId":"data","scope":"server","docId":"kibDataSearchPluginApi","section":"def-server.ISearchStrategy","text":"ISearchStrategy"},""]},{"id":"def-server.ISearchStart.asScoped","type":"Function","label":"asScoped","description":[],"source":{"path":"src/plugins/data/server/search/types.ts","lineNumber":112,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L112"},"signature":["(request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},") => ",{"pluginId":"data","scope":"server","docId":"kibDataSearchPluginApi","section":"def-server.IScopedSearchClient","text":"IScopedSearchClient"}]},{"id":"def-server.ISearchStart.searchSource","type":"Object","label":"searchSource","description":[],"source":{"path":"src/plugins/data/server/search/types.ts","lineNumber":113,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L113"},"signature":["{ asScoped: (request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},") => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchStartSearchSource","text":"ISearchStartSearchSource"},">; }"]}],"source":{"path":"src/plugins/data/server/search/types.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L99"},"initialIsOpen":false},{"id":"def-server.SearchStrategyDependencies","type":"Interface","label":"SearchStrategyDependencies","description":[],"children":[{"id":"def-server.SearchStrategyDependencies.savedObjectsClient","type":"Object","label":"savedObjectsClient","description":[],"source":{"path":"src/plugins/data/server/search/types.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L36"},"signature":["Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">"]},{"id":"def-server.SearchStrategyDependencies.esClient","type":"Object","label":"esClient","description":[],"source":{"path":"src/plugins/data/server/search/types.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L37"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.IScopedClusterClient","text":"IScopedClusterClient"}]},{"id":"def-server.SearchStrategyDependencies.uiSettingsClient","type":"Object","label":"uiSettingsClient","description":[],"source":{"path":"src/plugins/data/server/search/types.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L38"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.IUiSettingsClient","text":"IUiSettingsClient"}]},{"id":"def-server.SearchStrategyDependencies.searchSessionsClient","type":"Object","label":"searchSessionsClient","description":[],"source":{"path":"src/plugins/data/server/search/types.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L39"},"signature":[{"pluginId":"data","scope":"server","docId":"kibDataSearchPluginApi","section":"def-server.IScopedSearchSessionsClient","text":"IScopedSearchSessionsClient"},""]}],"source":{"path":"src/plugins/data/server/search/types.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L35"},"initialIsOpen":false},{"id":"def-server.SearchUsage","type":"Interface","label":"SearchUsage","description":[],"children":[{"id":"def-server.SearchUsage.trackError","type":"Function","label":"trackError","signature":["() => Promise"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/server/search/collectors/usage.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/collectors/usage.ts#L18"}},{"id":"def-server.SearchUsage.trackSuccess","type":"Function","label":"trackSuccess","signature":["(duration: number) => Promise"],"description":[],"children":[{"type":"number","label":"duration","isRequired":true,"signature":["number"],"description":[],"source":{"path":"src/plugins/data/server/search/collectors/usage.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/collectors/usage.ts#L19"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/server/search/collectors/usage.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/collectors/usage.ts#L19"}}],"source":{"path":"src/plugins/data/server/search/collectors/usage.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/collectors/usage.ts#L17"},"initialIsOpen":false},{"id":"def-server.ISearchSessionService","type":"Interface","label":"ISearchSessionService","signature":[{"pluginId":"data","scope":"server","docId":"kibDataSearchPluginApi","section":"def-server.ISearchSessionService","text":"ISearchSessionService"},""],"description":[],"children":[{"id":"def-server.ISearchSessionService.asScopedProvider","type":"Function","label":"asScopedProvider","description":[],"source":{"path":"src/plugins/data/server/search/session/types.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/session/types.ts#L37"},"signature":["(core: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreStart","text":"CoreStart"},") => (request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},") => ",{"pluginId":"data","scope":"server","docId":"kibDataSearchPluginApi","section":"def-server.IScopedSearchSessionsClient","text":"IScopedSearchSessionsClient"},""]}],"source":{"path":"src/plugins/data/server/search/session/types.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/session/types.ts#L36"},"initialIsOpen":false},{"id":"def-server.DataRequestHandlerContext","type":"Interface","label":"DataRequestHandlerContext","signature":[{"pluginId":"data","scope":"server","docId":"kibDataSearchPluginApi","section":"def-server.DataRequestHandlerContext","text":"DataRequestHandlerContext"}," extends ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.RequestHandlerContext","text":"RequestHandlerContext"}],"description":[],"children":[{"id":"def-server.DataRequestHandlerContext.search","type":"Object","label":"search","description":[],"source":{"path":"src/plugins/data/server/search/types.ts","lineNumber":124,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L124"},"signature":[{"pluginId":"data","scope":"server","docId":"kibDataSearchPluginApi","section":"def-server.IScopedSearchClient","text":"IScopedSearchClient"}]}],"source":{"path":"src/plugins/data/server/search/types.ts","lineNumber":123,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L123"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-server.SearchRequestHandlerContext","type":"Type","label":"SearchRequestHandlerContext","description":[],"source":{"path":"src/plugins/data/server/search/types.ts","lineNumber":118,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/server/search/types.ts#L118"},"signature":["IScopedSearchClient"],"initialIsOpen":false}],"objects":[]},"common":{"classes":[{"id":"def-common.AggConfig","type":"Class","label":"AggConfig","description":[],"children":[{"id":"def-common.AggConfig.ensureIds","type":"Function","label":"ensureIds","signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},".ensureIds"],"description":["\nEnsure that all of the objects in the list have ids, the objects\nand list are modified by reference.\n"],"children":[{"type":"Array","label":"list","isRequired":true,"signature":["any[]"],"description":["- a list of objects, objects can be anything really"],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L63"}}],"tags":["return"],"returnComment":["- the list that was passed in"],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L63"}},{"id":"def-common.AggConfig.nextId","type":"Function","label":"nextId","signature":["typeof ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},".nextId"],"description":["\nCalculate the next id based on the ids in this list\n"],"children":[{"type":"Array","label":"list","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},"[]"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L83"}}],"tags":["return"],"returnComment":["list - a list of objects with id properties"],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L83"}},{"id":"def-common.AggConfig.aggConfigs","type":"Object","label":"aggConfigs","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L92"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfigs","text":"AggConfigs"}]},{"id":"def-common.AggConfig.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":93,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L93"}},{"id":"def-common.AggConfig.enabled","type":"boolean","label":"enabled","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L94"}},{"id":"def-common.AggConfig.params","type":"Any","label":"params","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L95"},"signature":["any"]},{"id":"def-common.AggConfig.parent","type":"Object","label":"parent","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L96"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfigs","text":"AggConfigs"}," | undefined"]},{"id":"def-common.AggConfig.brandNew","type":"CompoundType","label":"brandNew","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L97"},"signature":["boolean | undefined"]},{"id":"def-common.AggConfig.schema","type":"string","label":"schema","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L98"},"signature":["string | undefined"]},{"id":"def-common.AggConfig.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"aggConfigs","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfigs","text":"AggConfigs"}],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L104"}},{"type":"Object","label":"opts","isRequired":true,"signature":["Pick & Pick<{ type: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IAggType","text":"IAggType"},"; }, \"type\"> & Pick<{ type: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IAggType","text":"IAggType"},"; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L104"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L104"}},{"id":"def-common.AggConfig.setParams","type":"Function","label":"setParams","signature":["(from: any) => void"],"description":["\nWrite the current values to this.params, filling in the defaults as we go\n"],"children":[{"type":"Any","label":"from","isRequired":true,"signature":["any"],"description":["- optional object to read values from,\n used when initializing"],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":134,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L134"}}],"tags":["return"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":134,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L134"}},{"id":"def-common.AggConfig.getParam","type":"Function","label":"getParam","signature":["(key: string) => any"],"description":[],"children":[{"type":"string","label":"key","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":171,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L171"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":171,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L171"}},{"id":"def-common.AggConfig.write","type":"Function","label":"write","signature":["(aggs?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfigs","text":"AggConfigs"}," | undefined) => Record"],"description":[],"children":[{"type":"Object","label":"aggs","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfigs","text":"AggConfigs"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":175,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L175"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":175,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L175"}},{"id":"def-common.AggConfig.isFilterable","type":"Function","label":"isFilterable","signature":["() => boolean"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":179,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L179"}},{"id":"def-common.AggConfig.createFilter","type":"Function","label":"createFilter","signature":["(key: string, params?: {}) => any"],"description":[],"children":[{"type":"string","label":"key","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":183,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L183"}},{"type":"Object","label":"params","isRequired":true,"signature":["{}"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":183,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L183"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":183,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L183"}},{"id":"def-common.AggConfig.onSearchRequestStart","type":"Function","label":"onSearchRequestStart","signature":["(searchSource: Pick<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"},", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">, options?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"}," | undefined) => Promise | Promise"],"description":["\n Hook for pre-flight logic, see AggType#onSearchRequestStart"],"children":[{"type":"Object","label":"searchSource","isRequired":true,"signature":["Pick<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"},", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":209,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L209"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":209,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L209"}}],"tags":["return"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":209,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L209"}},{"id":"def-common.AggConfig.toDsl","type":"Function","label":"toDsl","signature":["(aggConfigs?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfigs","text":"AggConfigs"}," | undefined) => any"],"description":["\nConvert this aggConfig to its dsl syntax.\n\nAdds params and adhoc subaggs to a pojo, then returns it\n"],"children":[{"type":"Object","label":"aggConfigs","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfigs","text":"AggConfigs"}," | undefined"],"description":["- the config object to convert"],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":230,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L230"}}],"tags":["return"],"returnComment":["- if the config has a dsl representation, it is\n returned, else undefined is returned"],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":230,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L230"}},{"id":"def-common.AggConfig.serialize","type":"Function","label":"serialize","signature":["() => { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined; schema?: string | undefined; }"],"description":[],"children":[],"tags":[],"returnComment":["Returns a serialized representation of an AggConfig."],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":259,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L259"}},{"id":"def-common.AggConfig.toJSON","type":"Function","label":"toJSON","signature":["() => { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined; schema?: string | undefined; }"],"description":[],"children":[],"tags":["deprecated"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":290,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L290"}},{"id":"def-common.AggConfig.toSerializedFieldFormat","type":"Function","label":"toSerializedFieldFormat","signature":["() => {}"],"description":["\nReturns a serialized field format for the field used in this agg.\nThis can be passed to fieldFormats.deserialize to get the field\nformat instance.\n"],"children":[],"tags":["public"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":301,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L301"}},{"id":"def-common.AggConfig.toExpressionAst","type":"Function","label":"toExpressionAst","signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}," | undefined"],"description":[],"children":[],"tags":[],"returnComment":["Returns an ExpressionAst representing the this agg type."],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":310,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L310"}},{"id":"def-common.AggConfig.getAggParams","type":"Function","label":"getAggParams","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamType","text":"AggParamType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},">[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":365,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L365"}},{"id":"def-common.AggConfig.getRequestAggs","type":"Function","label":"getRequestAggs","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":369,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L369"}},{"id":"def-common.AggConfig.getResponseAggs","type":"Function","label":"getResponseAggs","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":373,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L373"}},{"id":"def-common.AggConfig.getValue","type":"Function","label":"getValue","signature":["(bucket: any) => any"],"description":[],"children":[{"type":"Any","label":"bucket","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":377,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L377"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":377,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L377"}},{"id":"def-common.AggConfig.getKey","type":"Function","label":"getKey","signature":["(bucket: any, key?: string | undefined) => any"],"description":[],"children":[{"type":"Any","label":"bucket","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":381,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L381"}},{"type":"string","label":"key","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":381,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L381"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":381,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L381"}},{"id":"def-common.AggConfig.getFieldDisplayName","type":"Function","label":"getFieldDisplayName","signature":["() => any"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":389,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L389"}},{"id":"def-common.AggConfig.getField","type":"Function","label":"getField","signature":["() => any"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":395,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L395"}},{"id":"def-common.AggConfig.getValueBucketPath","type":"Function","label":"getValueBucketPath","signature":["() => string"],"description":["\nReturns the bucket path containing the main value the agg will produce\n(e.g. for sum of bytes it will point to the sum, for median it will point\n to the 50 percentile in the percentile multi value bucket)"],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":404,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L404"}},{"id":"def-common.AggConfig.makeLabel","type":"Function","label":"makeLabel","signature":["(percentageMode?: boolean) => any"],"description":[],"children":[{"type":"boolean","label":"percentageMode","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":408,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L408"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":408,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L408"}},{"id":"def-common.AggConfig.getIndexPattern","type":"Function","label":"getIndexPattern","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":422,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L422"}},{"id":"def-common.AggConfig.getTimeRange","type":"Function","label":"getTimeRange","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"}," | undefined"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":426,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L426"}},{"id":"def-common.AggConfig.fieldName","type":"Function","label":"fieldName","signature":["() => any"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":430,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L430"}},{"id":"def-common.AggConfig.fieldIsTimeField","type":"Function","label":"fieldIsTimeField","signature":["() => boolean | \"\" | undefined"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":435,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L435"}},{"id":"def-common.AggConfig.type","type":"Object","label":"type","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":442,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L442"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IAggType","text":"IAggType"}]},{"id":"def-common.AggConfig.type","type":"Object","label":"type","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":446,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L446"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IAggType","text":"IAggType"}]},{"id":"def-common.AggConfig.setType","type":"Function","label":"setType","signature":["(type: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IAggType","text":"IAggType"},") => void"],"description":[],"children":[{"type":"Object","label":"type","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IAggType","text":"IAggType"}],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":476,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L476"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":476,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L476"}}],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L55"},"initialIsOpen":false},{"id":"def-common.AggConfigs","type":"Class","label":"AggConfigs","description":[],"children":[{"id":"def-common.AggConfigs.indexPattern","type":"Object","label":"indexPattern","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L58"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}]},{"id":"def-common.AggConfigs.timeRange","type":"Object","label":"timeRange","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L59"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"}," | undefined"]},{"id":"def-common.AggConfigs.aggs","type":"Array","label":"aggs","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L62"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},"[]"]},{"id":"def-common.AggConfigs.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"indexPattern","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L65"}},{"type":"Array","label":"configStates","isRequired":true,"signature":["Pick & Pick<{ type: string | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IAggType","text":"IAggType"},"; }, \"type\"> & Pick<{ type: string | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IAggType","text":"IAggType"},"; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[]"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L66"}},{"type":"Object","label":"opts","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfigsOptions","text":"AggConfigsOptions"}],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L67"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L64"}},{"id":"def-common.AggConfigs.setTimeRange","type":"Function","label":"setTimeRange","signature":["(timeRange: ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"},") => void"],"description":[],"children":[{"type":"Object","label":"timeRange","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"}],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L79"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L79"}},{"id":"def-common.AggConfigs.clone","type":"Function","label":"clone","signature":["({ enabledOnly }?: { enabledOnly?: boolean | undefined; }) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfigs","text":"AggConfigs"}],"description":[],"children":[{"type":"Object","label":"{ enabledOnly = true }","isRequired":true,"signature":["{ enabledOnly?: boolean | undefined; }"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L97"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L97"}},{"id":"def-common.AggConfigs.createAggConfig","type":"Function","children":[{"type":"Object","label":"params","isRequired":true,"signature":["Pick & Pick<{ type: string | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IAggType","text":"IAggType"},"; }, \"type\"> & Pick<{ type: string | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IAggType","text":"IAggType"},"; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":111,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L111"}},{"type":"Object","label":"{ addToAggConfigs = true }","isRequired":true,"signature":["{ addToAggConfigs?: boolean | undefined; }"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":112,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L112"}}],"signature":["(params: Pick & Pick<{ type: string | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IAggType","text":"IAggType"},"; }, \"type\"> & Pick<{ type: string | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IAggType","text":"IAggType"}],"description":[],"label":"createAggConfig","source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L110"},"returnComment":[]},{"id":"def-common.AggConfigs.jsonDataEquals","type":"Function","label":"jsonDataEquals","signature":["(aggConfigs: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},"[]) => boolean"],"description":["\nData-by-data comparison of this Aggregation\nIgnores the non-array indexes"],"children":[{"type":"Array","label":"aggConfigs","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},"[]"],"description":["an AggConfigs instance"],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":153,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L153"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":153,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L153"}},{"id":"def-common.AggConfigs.toDsl","type":"Function","label":"toDsl","signature":["(hierarchical?: boolean) => Record"],"description":[],"children":[{"type":"boolean","label":"hierarchical","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":165,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L165"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":165,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L165"}},{"id":"def-common.AggConfigs.getAll","type":"Function","label":"getAll","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":227,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L227"}},{"id":"def-common.AggConfigs.byIndex","type":"Function","label":"byIndex","signature":["(index: number) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"}],"description":[],"children":[{"type":"number","label":"index","isRequired":true,"signature":["number"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":231,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L231"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":231,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L231"}},{"id":"def-common.AggConfigs.byId","type":"Function","label":"byId","signature":["(id: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"}," | undefined"],"description":[],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":235,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L235"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":235,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L235"}},{"id":"def-common.AggConfigs.byName","type":"Function","label":"byName","signature":["(name: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},"[]"],"description":[],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":239,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L239"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":239,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L239"}},{"id":"def-common.AggConfigs.byType","type":"Function","label":"byType","signature":["(type: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},"[]"],"description":[],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":243,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L243"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":243,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L243"}},{"id":"def-common.AggConfigs.byTypeName","type":"Function","label":"byTypeName","signature":["(type: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},"[]"],"description":[],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":247,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L247"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":247,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L247"}},{"id":"def-common.AggConfigs.bySchemaName","type":"Function","label":"bySchemaName","signature":["(schema: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},"[]"],"description":[],"children":[{"type":"string","label":"schema","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":251,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L251"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":251,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L251"}},{"id":"def-common.AggConfigs.getRequestAggs","type":"Function","label":"getRequestAggs","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":255,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L255"}},{"id":"def-common.AggConfigs.getRequestAggById","type":"Function","label":"getRequestAggById","signature":["(id: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"}," | undefined"],"description":[],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":269,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L269"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":269,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L269"}},{"id":"def-common.AggConfigs.getResponseAggs","type":"Function","label":"getResponseAggs","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},"[]"],"description":["\nGets the AggConfigs (and possibly ResponseAggConfigs) that\nrepresent the values that will be produced when all aggs\nare run.\n\nWith multi-value metric aggs it is possible for a single agg\nrequest to result in multiple agg values, which is why the length\nof a vis' responseValuesAggs may be different than the vis' aggs\n"],"children":[],"tags":["return"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":284,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L284"}},{"id":"def-common.AggConfigs.getResponseAggById","type":"Function","label":"getResponseAggById","signature":["(id: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"}," | undefined"],"description":["\nFind a response agg by it's id. This may be an agg in the aggConfigs, or one\ncreated specifically for a response value\n"],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":["- the id of the agg to find"],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":298,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L298"}}],"tags":["return"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":298,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L298"}},{"id":"def-common.AggConfigs.onSearchRequestStart","type":"Function","label":"onSearchRequestStart","signature":["(searchSource: Pick<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"},", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">, options?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"}," | undefined) => Promise<[unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown, unknown]>"],"description":[],"children":[{"type":"Object","label":"searchSource","isRequired":true,"signature":["Pick<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"},", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":307,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L307"}},{"type":"Object","label":"options","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":307,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L307"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":307,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L307"}}],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L57"},"initialIsOpen":false},{"id":"def-common.AggType","type":"Class","label":"AggType","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggType","text":"AggType"},""],"children":[{"id":"def-common.AggType.name","type":"string","label":"name","description":["\nthe unique, unchanging, name that we have assigned this aggType\n"],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L70"}},{"id":"def-common.AggType.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L72"}},{"id":"def-common.AggType.subtype","type":"string","label":"subtype","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L73"},"signature":["string | undefined"]},{"id":"def-common.AggType.dslName","type":"string","label":"dslName","description":["\nthe name of the elasticsearch aggregation that this aggType represents. Usually just this.name\n"],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L80"}},{"id":"def-common.AggType.expressionName","type":"string","label":"expressionName","description":["\nthe name of the expression function that this aggType represents.\n"],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":87,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L87"}},{"id":"def-common.AggType.title","type":"string","label":"title","description":["\nthe user friendly name that will be shown in the ui for this aggType\n"],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L94"}},{"id":"def-common.AggType.valueType","type":"CompoundType","label":"valueType","description":["\nThe type the values produced by this agg will have in the final data table.\nIf not specified, the type of the field is used."],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L99"},"signature":["\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\" | undefined"]},{"id":"def-common.AggType.makeLabel","type":"Function","label":"makeLabel","description":["\na function that will be called when this aggType is assigned to\nan aggConfig, and that aggConfig is being rendered (in a form, chart, etc.).\n"],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L108"},"signature":["((aggConfig: TAggConfig) => string) | (() => string)"]},{"id":"def-common.AggType.ordered","type":"Any","label":"ordered","description":["\nDescribes if this aggType creates data that is ordered, and if that ordered data\nis some sort of time series.\n\nIf the aggType does not create ordered data, set this to something \"falsy\".\n\nIf this does create orderedData, then the value should be an object.\n\nIf the orderdata is some sort of time series, `this.ordered` should be an object\nwith the property `date: true`\n"],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":123,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L123"},"signature":["any"]},{"id":"def-common.AggType.hasNoDsl","type":"boolean","label":"hasNoDsl","description":["\nFlag that prevents this aggregation from being included in the dsl. This is only\nused by the count aggregation (currently) since it doesn't really exist and it's output\nis available on every bucket.\n"],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L131"}},{"id":"def-common.AggType.createFilter","type":"Function","label":"createFilter","description":["\nThe method to create a filter representation of the bucket"],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":138,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L138"},"signature":["((aggConfig: TAggConfig, key: any, params?: any) => any) | undefined"]},{"id":"def-common.AggType.params","type":"Array","label":"params","description":["\nAn instance of {{#crossLink \"AggParams\"}}{{/crossLink}}.\n"],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":145,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L145"},"signature":["TParam[]"]},{"id":"def-common.AggType.getRequestAggs","type":"Function","label":"getRequestAggs","description":["\nDesigned for multi-value metric aggs, this method can return a\nset of AggConfigs that should replace this aggConfig in requests\n"],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":155,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L155"},"signature":["((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[])"]},{"id":"def-common.AggType.getResponseAggs","type":"Function","label":"getResponseAggs","description":["\nDesigned for multi-value metric aggs, this method can return a\nset of AggConfigs that should replace this aggConfig in result sets\nthat walk the AggConfig set.\n"],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":166,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L166"},"signature":["((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[])"]},{"id":"def-common.AggType.decorateAggConfig","type":"Function","label":"decorateAggConfig","description":["\nA function that will be called each time an aggConfig of this type\nis created, giving the agg type a chance to modify the agg config"],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":171,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L171"},"signature":["() => any"]},{"id":"def-common.AggType.postFlightRequest","type":"Function","label":"postFlightRequest","description":["\nA function that needs to be called after the main request has been made\nand should return an updated response"],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":184,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L184"},"signature":["(resp: any, aggConfigs: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfigs","text":"AggConfigs"},", aggConfig: TAggConfig, searchSource: Pick<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"},", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">, inspectorRequestAdapter?: ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.RequestAdapter","text":"RequestAdapter"}," | undefined, abortSignal?: AbortSignal | undefined, searchSessionId?: string | undefined) => Promise"]},{"id":"def-common.AggType.getSerializedFormat","type":"Function","label":"getSerializedFormat","description":["\nGet the serialized format for the values produced by this agg type,\noverridden by several metrics that always output a simple number.\nYou can pass this output to fieldFormatters.deserialize to get\nthe formatter instance.\n"],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":202,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L202"},"signature":["(agg: TAggConfig) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializedFieldFormat","text":"SerializedFieldFormat"},">"]},{"id":"def-common.AggType.getValue","type":"Function","label":"getValue","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":204,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L204"},"signature":["(agg: TAggConfig, bucket: any) => any"]},{"id":"def-common.AggType.getKey","type":"Function","label":"getKey","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":206,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L206"},"signature":["((bucket: any, key: any, agg: TAggConfig) => any) | undefined"]},{"id":"def-common.AggType.paramByName","type":"Function","children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":208,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L208"}}],"signature":["(name: string) => TParam | undefined"],"description":[],"label":"paramByName","source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":208,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L208"},"returnComment":[]},{"id":"def-common.AggType.getValueBucketPath","type":"Function","children":[{"type":"Uncategorized","label":"agg","isRequired":true,"signature":["TAggConfig"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":212,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L212"}}],"signature":["(agg: TAggConfig) => string"],"description":[],"label":"getValueBucketPath","source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":212,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L212"},"returnComment":[]},{"id":"def-common.AggType.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":["\nGeneric AggType Constructor\n\nUsed to create the values exposed by the agg_types module.\n"],"children":[{"type":"Object","label":"config","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggTypeConfig","text":"AggTypeConfig"},">"],"description":["- used to set the properties of the AggType"],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":225,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L225"}}],"tags":["class","private"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":225,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L225"}}],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L60"},"initialIsOpen":false},{"id":"def-common.AggTypesRegistry","type":"Class","label":"AggTypesRegistry","description":[],"children":[{"id":"def-common.AggTypesRegistry.setup","type":"Function","children":[],"signature":["() => { registerBucket: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BucketAggType","text":"BucketAggType"},">(name: N, type: T) => void; registerMetric: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggType","text":"MetricAggType"},">(name: N, type: T) => void; }"],"description":[],"label":"setup","source":{"path":"src/plugins/data/common/search/aggs/agg_types_registry.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_types_registry.ts#L31"},"returnComment":[]},{"id":"def-common.AggTypesRegistry.start","type":"Function","children":[],"signature":["() => { get: (name: string) => any; getAll: () => { buckets: any[]; metrics: any[]; }; }"],"description":[],"label":"start","source":{"path":"src/plugins/data/common/search/aggs/agg_types_registry.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_types_registry.ts#L60"},"returnComment":[]}],"source":{"path":"src/plugins/data/common/search/aggs/agg_types_registry.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_types_registry.ts#L27"},"initialIsOpen":false},{"id":"def-common.AggsCommonService","type":"Class","label":"AggsCommonService","description":["\nThe aggs service provides a means of modeling and manipulating the various\nElasticsearch aggregations supported by Kibana, providing the ability to\noutput the correct DSL when you are ready to send your request to ES."],"children":[{"id":"def-common.AggsCommonService.setup","type":"Function","label":"setup","signature":["({ registerFunction }: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggsCommonSetupDependencies","text":"AggsCommonSetupDependencies"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggsCommonSetup","text":"AggsCommonSetup"}],"description":[],"children":[{"type":"Object","label":"{ registerFunction }","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggsCommonSetupDependencies","text":"AggsCommonSetupDependencies"}],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/aggs_service.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/aggs_service.ts#L56"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/aggs_service.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/aggs_service.ts#L56"}},{"id":"def-common.AggsCommonService.start","type":"Function","label":"start","signature":["({ getConfig, getIndexPattern, isDefaultTimezone, }: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggsCommonStartDependencies","text":"AggsCommonStartDependencies"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggsCommonStart","text":"AggsCommonStart"}],"description":[],"children":[{"type":"Object","label":"{\n getConfig,\n getIndexPattern,\n isDefaultTimezone,\n }","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggsCommonStartDependencies","text":"AggsCommonStartDependencies"}],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/aggs_service.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/aggs_service.ts#L73"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/aggs_service.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/aggs_service.ts#L73"}}],"source":{"path":"src/plugins/data/common/search/aggs/aggs_service.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/aggs_service.ts#L53"},"initialIsOpen":false},{"id":"def-common.BucketAggType","type":"Class","label":"BucketAggType","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BucketAggType","text":"BucketAggType"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggType","text":"AggType"},">"],"children":[{"id":"def-common.BucketAggType.getKey","type":"Function","label":"getKey","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L35"},"signature":["(bucket: any, key: any, agg: TBucketAggConfig) => any"]},{"id":"def-common.BucketAggType.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L36"}},{"id":"def-common.BucketAggType.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"config","isRequired":true,"signature":["BucketAggTypeConfig"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L38"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L38"}}],"source":{"path":"src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L31"},"initialIsOpen":false},{"id":"def-common.CidrMask","type":"Class","label":"CidrMask","description":[],"children":[{"id":"def-common.CidrMask.initialAddress","type":"Object","label":"initialAddress","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts#L18"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.Ipv4Address","text":"Ipv4Address"}]},{"id":"def-common.CidrMask.prefixLength","type":"number","label":"prefixLength","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts#L19"}},{"id":"def-common.CidrMask.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"string","label":"mask","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts#L21"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts#L21"}},{"id":"def-common.CidrMask.getRange","type":"Function","label":"getRange","signature":["() => { from: string; to: string; }"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts#L33"}},{"id":"def-common.CidrMask.toString","type":"Function","label":"toString","signature":["() => string"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts#L44"}}],"source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/cidr_mask.ts#L17"},"initialIsOpen":false},{"id":"def-common.MetricAggType","type":"Class","label":"MetricAggType","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggType","text":"MetricAggType"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggType","text":"AggType"},">"],"children":[{"id":"def-common.MetricAggType.subtype","type":"string","label":"subtype","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L41"}},{"id":"def-common.MetricAggType.isScalable","type":"Function","label":"isScalable","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L42"},"signature":["() => boolean"]},{"id":"def-common.MetricAggType.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L43"}},{"id":"def-common.MetricAggType.getKey","type":"Function","children":[],"signature":["() => void"],"description":[],"label":"getKey","source":{"path":"src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L45"},"returnComment":[]},{"id":"def-common.MetricAggType.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"config","isRequired":true,"signature":["MetricAggTypeConfig"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L47"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L47"}}],"source":{"path":"src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L37"},"initialIsOpen":false},{"id":"def-common.AggParamType","type":"Class","label":"AggParamType","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamType","text":"AggParamType"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseParamType","text":"BaseParamType"},""],"children":[{"id":"def-common.AggParamType.makeAgg","type":"Function","label":"makeAgg","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/agg.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/agg.ts#L15"},"signature":["(agg: TAggConfig, state?: { type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined; schema?: string | undefined; } | undefined) => TAggConfig"]},{"id":"def-common.AggParamType.allowedAggs","type":"Array","label":"allowedAggs","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/agg.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/agg.ts#L16"},"signature":["string[]"]},{"id":"def-common.AggParamType.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"config","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/agg.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/agg.ts#L18"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/agg.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/agg.ts#L18"}}],"source":{"path":"src/plugins/data/common/search/aggs/param_types/agg.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/agg.ts#L12"},"initialIsOpen":false},{"id":"def-common.BaseParamType","type":"Class","label":"BaseParamType","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseParamType","text":"BaseParamType"},""],"children":[{"id":"def-common.BaseParamType.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/base.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L15"}},{"id":"def-common.BaseParamType.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/base.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L16"}},{"id":"def-common.BaseParamType.displayName","type":"string","label":"displayName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/base.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L17"}},{"id":"def-common.BaseParamType.required","type":"boolean","label":"required","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/base.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L18"}},{"id":"def-common.BaseParamType.advanced","type":"boolean","label":"advanced","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/base.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L19"}},{"id":"def-common.BaseParamType.default","type":"Any","label":"default","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/base.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L20"},"signature":["any"]},{"id":"def-common.BaseParamType.write","type":"Function","label":"write","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/base.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L21"},"signature":["(aggConfig: TAggConfig, output: Record, aggConfigs?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfigs","text":"AggConfigs"}," | undefined, locals?: Record | undefined) => void"]},{"id":"def-common.BaseParamType.serialize","type":"Function","label":"serialize","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/base.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L27"},"signature":["(value: any, aggConfig?: TAggConfig | undefined) => any"]},{"id":"def-common.BaseParamType.deserialize","type":"Function","label":"deserialize","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/base.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L28"},"signature":["(value: any, aggConfig?: TAggConfig | undefined) => any"]},{"id":"def-common.BaseParamType.toExpressionAst","type":"Function","label":"toExpressionAst","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/base.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L29"},"signature":["((value: any) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}," | undefined) | undefined"]},{"id":"def-common.BaseParamType.options","type":"Array","label":"options","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/base.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L30"},"signature":["any[]"]},{"id":"def-common.BaseParamType.valueType","type":"Any","label":"valueType","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/base.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L31"},"signature":["any"]},{"id":"def-common.BaseParamType.modifyAggConfigOnSearchRequestStart","type":"Function","label":"modifyAggConfigOnSearchRequestStart","description":["\n A function that will be called before an aggConfig is serialized and sent to ES.\n Allows aggConfig to retrieve values needed for serialization\n Example usage: an aggregation needs to know the min/max of a field to determine an appropriate interval\n"],"source":{"path":"src/plugins/data/common/search/aggs/param_types/base.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L45"},"signature":["(aggConfig: TAggConfig, searchSource?: Pick<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"},", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined, options?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"}," | undefined) => void"]},{"id":"def-common.BaseParamType.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"config","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/base.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L51"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/base.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L51"}}],"source":{"path":"src/plugins/data/common/search/aggs/param_types/base.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/base.ts#L14"},"initialIsOpen":false},{"id":"def-common.FieldParamType","type":"Class","label":"FieldParamType","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.FieldParamType","text":"FieldParamType"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseParamType","text":"BaseParamType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},">"],"children":[{"id":"def-common.FieldParamType.required","type":"boolean","label":"required","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/field.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/field.ts#L24"}},{"id":"def-common.FieldParamType.scriptable","type":"boolean","label":"scriptable","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/field.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/field.ts#L25"}},{"id":"def-common.FieldParamType.filterFieldTypes","type":"CompoundType","label":"filterFieldTypes","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/field.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/field.ts#L26"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.FieldTypes","text":"FieldTypes"}]},{"id":"def-common.FieldParamType.onlyAggregatable","type":"boolean","label":"onlyAggregatable","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/field.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/field.ts#L27"}},{"id":"def-common.FieldParamType.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"config","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/field.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/field.ts#L29"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/field.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/field.ts#L29"}},{"id":"def-common.FieldParamType.getAvailableFields","type":"Function","children":[{"type":"Object","label":"aggConfig","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"}],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/field.ts","lineNumber":100,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/field.ts#L100"}}],"signature":["(aggConfig: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"},"[]"],"description":["\nfilter the fields to the available ones"],"label":"getAvailableFields","source":{"path":"src/plugins/data/common/search/aggs/param_types/field.ts","lineNumber":100,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/field.ts#L100"},"returnComment":[]}],"source":{"path":"src/plugins/data/common/search/aggs/param_types/field.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/field.ts#L23"},"initialIsOpen":false},{"id":"def-common.JsonParamType","type":"Class","label":"JsonParamType","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.JsonParamType","text":"JsonParamType"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseParamType","text":"BaseParamType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},">"],"children":[{"id":"def-common.JsonParamType.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"config","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/json.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/json.ts#L15"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/json.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/json.ts#L15"}}],"source":{"path":"src/plugins/data/common/search/aggs/param_types/json.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/json.ts#L14"},"initialIsOpen":false},{"id":"def-common.OptionedParamType","type":"Class","label":"OptionedParamType","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.OptionedParamType","text":"OptionedParamType"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseParamType","text":"BaseParamType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},">"],"children":[{"id":"def-common.OptionedParamType.options","type":"Array","label":"options","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/optioned.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L20"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.OptionedValueProp","text":"OptionedValueProp"},"[]"]},{"id":"def-common.OptionedParamType.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"config","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/optioned.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L22"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/optioned.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L22"}}],"source":{"path":"src/plugins/data/common/search/aggs/param_types/optioned.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L19"},"initialIsOpen":false},{"id":"def-common.StringParamType","type":"Class","label":"StringParamType","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.StringParamType","text":"StringParamType"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseParamType","text":"BaseParamType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},">"],"children":[{"id":"def-common.StringParamType.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"config","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/string.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/string.ts#L13"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/string.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/string.ts#L13"}}],"source":{"path":"src/plugins/data/common/search/aggs/param_types/string.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/string.ts#L12"},"initialIsOpen":false},{"id":"def-common.InvalidEsCalendarIntervalError","type":"Class","label":"InvalidEsCalendarIntervalError","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.InvalidEsCalendarIntervalError","text":"InvalidEsCalendarIntervalError"}," extends Error"],"children":[{"id":"def-common.InvalidEsCalendarIntervalError.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"string","label":"interval","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts#L14"}},{"type":"number","label":"value","isRequired":true,"signature":["number"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts#L15"}},{"type":"CompoundType","label":"unit","isRequired":true,"signature":["Unit"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts#L16"}},{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts#L17"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts#L13"}}],"source":{"path":"src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_calendar_interval_error.ts#L12"},"initialIsOpen":false},{"id":"def-common.InvalidEsIntervalFormatError","type":"Class","label":"InvalidEsIntervalFormatError","description":[],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.InvalidEsIntervalFormatError","text":"InvalidEsIntervalFormatError"}," extends Error"],"children":[{"id":"def-common.InvalidEsIntervalFormatError.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"string","label":"interval","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts#L12"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts#L12"}}],"source":{"path":"src/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/invalid_es_interval_format_error.ts#L11"},"initialIsOpen":false},{"id":"def-common.Ipv4Address","type":"Class","label":"Ipv4Address","description":[],"children":[{"id":"def-common.Ipv4Address.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"CompoundType","label":"ipAddress","isRequired":true,"signature":["React.ReactText"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/ipv4_address.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/ipv4_address.ts#L25"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/ipv4_address.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/ipv4_address.ts#L25"}},{"id":"def-common.Ipv4Address.toString","type":"Function","label":"toString","signature":["() => string"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/ipv4_address.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/ipv4_address.ts#L50"}},{"id":"def-common.Ipv4Address.valueOf","type":"Function","label":"valueOf","signature":["() => number"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/ipv4_address.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/ipv4_address.ts#L60"}}],"source":{"path":"src/plugins/data/common/search/aggs/utils/ipv4_address.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/ipv4_address.ts#L22"},"initialIsOpen":false},{"id":"def-common.RequestFailure","type":"Class","label":"RequestFailure","description":["\nRequest Failure - When an entire multi request fails"],"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.RequestFailure","text":"RequestFailure"}," extends ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.KbnError","text":"KbnError"}],"children":[{"id":"def-common.RequestFailure.resp","type":"Object","label":"resp","description":[],"source":{"path":"src/plugins/data/common/search/search_source/fetch/request_error.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/request_error.ts#L19"},"signature":["SearchResponse"," | undefined"]},{"id":"def-common.RequestFailure.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"CompoundType","label":"err","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchError","text":"SearchError"}," | null"],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/fetch/request_error.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/request_error.ts#L20"}},{"type":"Object","label":"resp","isRequired":false,"signature":["SearchResponse"," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/fetch/request_error.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/request_error.ts#L20"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/fetch/request_error.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/request_error.ts#L20"}}],"source":{"path":"src/plugins/data/common/search/search_source/fetch/request_error.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/request_error.ts#L18"},"initialIsOpen":false},{"id":"def-common.SearchSource","type":"Class","label":"SearchSource","description":[],"children":[{"id":"def-common.SearchSource.history","type":"Array","label":"history","description":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":112,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L112"},"signature":["Record[]"]},{"id":"def-common.SearchSource.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"fields","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"}],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L116"}},{"type":"Object","label":"dependencies","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceDependencies","text":"SearchSourceDependencies"}],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L116"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L116"}},{"id":"def-common.SearchSource.setPreferredSearchStrategyId","type":"Function","label":"setPreferredSearchStrategyId","signature":["(searchStrategyId: string) => void"],"description":["**\nPUBLIC API\n\ninternal, dont use"],"children":[{"type":"string","label":"searchStrategyId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":134,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L134"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":134,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L134"}},{"id":"def-common.SearchSource.setField","type":"Function","label":"setField","signature":["(field: K, value: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"},"[K]) => this"],"description":["\nsets value to a single search source field"],"children":[{"type":"Uncategorized","label":"field","isRequired":true,"signature":["K"],"description":[": field name"],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":143,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L143"}},{"type":"Uncategorized","label":"value","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"},"[K]"],"description":[": value for the field"],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":143,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L143"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":143,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L143"}},{"id":"def-common.SearchSource.removeField","type":"Function","label":"removeField","signature":["(field: K) => this"],"description":["\nremove field"],"children":[{"type":"Uncategorized","label":"field","isRequired":true,"signature":["K"],"description":[": field name"],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":155,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L155"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":155,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L155"}},{"id":"def-common.SearchSource.setFields","type":"Function","label":"setFields","signature":["(newFields: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"},") => this"],"description":["\nInternal, do not use. Overrides all search source fields with the new field array.\n"],"children":[{"type":"Object","label":"newFields","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"}],"description":["New field array."],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":166,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L166"}}],"tags":["private"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":166,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L166"}},{"id":"def-common.SearchSource.getId","type":"Function","label":"getId","signature":["() => string"],"description":["\nreturns search source id"],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":174,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L174"}},{"id":"def-common.SearchSource.getFields","type":"Function","label":"getFields","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"}],"description":["\nreturns all search source fields"],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":181,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L181"}},{"id":"def-common.SearchSource.getField","type":"Function","label":"getField","signature":["(field: K, recurse?: boolean) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"},"[K]"],"description":["\nGets a single field from the fields"],"children":[{"type":"Uncategorized","label":"field","isRequired":true,"signature":["K"],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":188,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L188"}},{"type":"boolean","label":"recurse","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":188,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L188"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":188,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L188"}},{"id":"def-common.SearchSource.getOwnField","type":"Function","label":"getOwnField","signature":["(field: K) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"},"[K]"],"description":["\nGet the field from our own fields, don't traverse up the chain"],"children":[{"type":"Uncategorized","label":"field","isRequired":true,"signature":["K"],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":199,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L199"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":199,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L199"}},{"id":"def-common.SearchSource.create","type":"Function","label":"create","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"}],"description":[],"children":[],"tags":["deprecated"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":206,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L206"}},{"id":"def-common.SearchSource.createCopy","type":"Function","label":"createCopy","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"}],"description":["\ncreates a copy of this search source (without its children)"],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":213,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L213"}},{"id":"def-common.SearchSource.createChild","type":"Function","label":"createChild","signature":["(options?: {}) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"}],"description":["\ncreates a new child search source"],"children":[{"type":"Object","label":"options","isRequired":true,"signature":["{}"],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":227,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L227"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":227,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L227"}},{"id":"def-common.SearchSource.setParent","type":"Function","label":"setParent","signature":["(parent?: Pick<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"},", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined, options?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceOptions","text":"SearchSourceOptions"},") => this"],"description":["\nSet a searchSource that this source should inherit from"],"children":[{"type":"Object","label":"parent","isRequired":false,"signature":["Pick<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"},", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined"],"description":["- the parent searchSource"],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":239,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L239"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceOptions","text":"SearchSourceOptions"}],"description":["- the inherit options"],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":239,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L239"}}],"tags":["return"],"returnComment":["- chainable"],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":239,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L239"}},{"id":"def-common.SearchSource.getParent","type":"Function","label":"getParent","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"}," | undefined"],"description":["\nGet the parent of this SearchSource"],"children":[],"tags":["return"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":249,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L249"}},{"id":"def-common.SearchSource.fetch$","type":"Function","label":"fetch$","signature":["(options?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"},") => ","Observable","<","SearchResponse",">"],"description":["\nFetch this source from Elasticsearch, returning an observable over the response(s)"],"children":[{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"}],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":257,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L257"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":257,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L257"}},{"id":"def-common.SearchSource.fetch","type":"Function","label":"fetch","signature":["(options?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"},") => Promise<","SearchResponse",">"],"description":["\nFetch this source and reject the returned Promise on error"],"children":[{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"}],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":284,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L284"}}],"tags":["deprecated"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":284,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L284"}},{"id":"def-common.SearchSource.onRequestStart","type":"Function","label":"onRequestStart","signature":["(handler: (searchSource: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"},", options?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"}," | undefined) => Promise) => void"],"description":["\n Add a handler that will be notified whenever requests start"],"children":[{"type":"Function","label":"handler","isRequired":true,"signature":["(searchSource: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"},", options?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"}," | undefined) => Promise"],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":294,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L294"}}],"tags":["return"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":293,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L293"}},{"id":"def-common.SearchSource.getSearchRequestBody","type":"Function","label":"getSearchRequestBody","signature":["() => Promise"],"description":["\nReturns body contents of the search request, often referred as query DSL."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":302,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L302"}},{"id":"def-common.SearchSource.destroy","type":"Function","label":"destroy","signature":["() => void"],"description":["\nCompletely destroy the SearchSource."],"children":[],"tags":["return"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":311,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L311"}},{"id":"def-common.SearchSource.getSerializedFields","type":"Function","label":"getSerializedFields","signature":["(recurse?: boolean) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"}],"description":["\nserializes search source fields (which can later be passed to {@link ISearchStartSearchSource})"],"children":[{"type":"boolean","label":"recurse","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":689,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L689"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":689,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L689"}},{"id":"def-common.SearchSource.serialize","type":"Function","label":"serialize","signature":["() => { searchSourceJSON: string; references: ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[]; }"],"description":["\nSerializes the instance to a JSON string and a set of referenced objects.\nUse this method to get a representation of the search source which can be stored in a saved object.\n\nThe references returned by this function can be mixed with other references in the same object,\nhowever make sure there are no name-collisions. The references will be named `kibanaSavedObjectMeta.searchSourceJSON.index`\nand `kibanaSavedObjectMeta.searchSourceJSON.filter[].meta.index`.\n\nUsing `createSearchSource`, the instance can be re-created."],"children":[],"tags":["public"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":718,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L718"}}],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L104"},"initialIsOpen":false},{"id":"def-common.SearchSourceService","type":"Class","label":"SearchSourceService","description":[],"children":[{"id":"def-common.SearchSourceService.setup","type":"Function","label":"setup","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source_service.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source_service.ts#L13"}},{"id":"def-common.SearchSourceService.start","type":"Function","label":"start","signature":["(indexPatterns: Pick<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternsService","text":"IndexPatternsService"},", \"get\" | \"delete\" | \"create\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"find\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">, dependencies: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceDependencies","text":"SearchSourceDependencies"},") => { create: (searchSourceFields?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"},") => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"},">; createEmpty: () => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"}],"description":[],"children":[{"type":"Object","label":"indexPatterns","isRequired":true,"signature":["Pick<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternsService","text":"IndexPatternsService"},", \"get\" | \"delete\" | \"create\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"find\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">"],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source_service.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source_service.ts#L15"}},{"type":"Object","label":"dependencies","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceDependencies","text":"SearchSourceDependencies"}],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source_service.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source_service.ts#L15"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source_service.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source_service.ts#L15"}},{"id":"def-common.SearchSourceService.stop","type":"Function","label":"stop","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source_service.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source_service.ts#L30"}}],"source":{"path":"src/plugins/data/common/search/search_source/search_source_service.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source_service.ts#L12"},"initialIsOpen":false}],"functions":[{"id":"def-common.getAggTypes","type":"Function","children":[],"signature":["() => { metrics: ({ name: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.METRIC_TYPES","text":"METRIC_TYPES"},"; fn: () => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggType","text":"MetricAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IMetricAggConfig","text":"IMetricAggConfig"},">; } | { name: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.METRIC_TYPES","text":"METRIC_TYPES"},"; fn: () => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggType","text":"MetricAggType"}],"description":[],"label":"getAggTypes","source":{"path":"src/plugins/data/common/search/aggs/agg_types.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_types.ts#L26"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getAggTypesFunctions","type":"Function","children":[],"signature":["() => ((() => FunctionDefinition) | (() => FunctionDefinition) | (() => FunctionDefinition) | (() => FunctionDefinition) | (() => FunctionDefinition) | (() => FunctionDefinition) | (() => FunctionDefinition) | (() => FunctionDefinition) | (() => FunctionDefinition) | (() => FunctionDefinition) | (() => FunctionDefinition) | (() => FunctionDefinition) | (() => FunctionDefinition) | (() => FunctionDefinition) | (() => FunctionDefinition) | (() => FunctionDefinition) | (() => FunctionDefinition) | (() => FunctionDefinition) | (() => FunctionDefinition) | (() => FunctionDefinition) | (() => FunctionDefinition) | (() => FunctionDefinition) | (() => FunctionDefinition) | (() => FunctionDefinition) | (() => FunctionDefinition) | (() => FunctionDefinition) | (() => FunctionDefinition) | (() => FunctionDefinition) | (() => FunctionDefinition) | (() => FunctionDefinition) | (() => FunctionDefinition) | (() => FunctionDefinition))[]"],"description":[],"label":"getAggTypesFunctions","source":{"path":"src/plugins/data/common/search/aggs/agg_types.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_types.ts#L66"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.isAutoInterval","type":"Function","children":[{"type":"Unknown","label":"value","isRequired":true,"signature":["unknown"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/_interval_options.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/_interval_options.ts#L13"}}],"signature":["(value: unknown) => boolean"],"description":[],"label":"isAutoInterval","source":{"path":"src/plugins/data/common/search/aggs/buckets/_interval_options.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/_interval_options.ts#L13"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.isBucketAggType","type":"Function","label":"isBucketAggType","signature":["(aggConfig: any) => boolean"],"description":[],"children":[{"type":"Any","label":"aggConfig","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L49"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L49"},"initialIsOpen":false},{"id":"def-common.aggDateHistogram","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggDateHistogram","source":{"path":"src/plugins/data/common/search/aggs/buckets/date_histogram_fn.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram_fn.ts#L30"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.isDateHistogramBucketAggConfig","type":"Function","label":"isDateHistogramBucketAggConfig","signature":["(agg: any) => boolean"],"description":[],"children":[{"type":"Any","label":"agg","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_histogram.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L57"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_histogram.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L57"},"initialIsOpen":false},{"id":"def-common.getDateHistogramBucketAgg","type":"Function","children":[{"type":"Object","label":"{\n calculateBounds,\n isDefaultTimezone,\n getConfig,\n}","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.DateHistogramBucketAggDependencies","text":"DateHistogramBucketAggDependencies"}],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_histogram.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L74"}}],"signature":["({ calculateBounds, isDefaultTimezone, getConfig, }: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.DateHistogramBucketAggDependencies","text":"DateHistogramBucketAggDependencies"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BucketAggType","text":"BucketAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IBucketDateHistogramAggConfig","text":"IBucketDateHistogramAggConfig"},">"],"description":[],"label":"getDateHistogramBucketAgg","source":{"path":"src/plugins/data/common/search/aggs/buckets/date_histogram.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L74"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.aggDateRange","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggDateRange","source":{"path":"src/plugins/data/common/search/aggs/buckets/date_range_fn.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_range_fn.ts#L30"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getDateRangeBucketAgg","type":"Function","children":[{"type":"Object","label":"{\n isDefaultTimezone,\n getConfig,\n}","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.DateRangeBucketAggDependencies","text":"DateRangeBucketAggDependencies"}],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_range.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_range.ts#L37"}}],"signature":["({ isDefaultTimezone, getConfig, }: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.DateRangeBucketAggDependencies","text":"DateRangeBucketAggDependencies"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BucketAggType","text":"BucketAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IBucketAggConfig","text":"IBucketAggConfig"},">"],"description":[],"label":"getDateRangeBucketAgg","source":{"path":"src/plugins/data/common/search/aggs/buckets/date_range.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_range.ts#L37"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.aggFilter","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggFilter","source":{"path":"src/plugins/data/common/search/aggs/buckets/filter_fn.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/filter_fn.ts#L30"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getFilterBucketAgg","type":"Function","children":[],"signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BucketAggType","text":"BucketAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IBucketAggConfig","text":"IBucketAggConfig"},">"],"description":[],"label":"getFilterBucketAgg","source":{"path":"src/plugins/data/common/search/aggs/buckets/filter.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/filter.ts#L24"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.aggFilters","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggFilters","source":{"path":"src/plugins/data/common/search/aggs/buckets/filters_fn.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/filters_fn.ts#L30"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getFiltersBucketAgg","type":"Function","children":[{"type":"Object","label":"{ getConfig }","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.FiltersBucketAggDependencies","text":"FiltersBucketAggDependencies"}],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/filters.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/filters.ts#L43"}}],"signature":["({ getConfig }: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.FiltersBucketAggDependencies","text":"FiltersBucketAggDependencies"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BucketAggType","text":"BucketAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IBucketAggConfig","text":"IBucketAggConfig"},">"],"description":[],"label":"getFiltersBucketAgg","source":{"path":"src/plugins/data/common/search/aggs/buckets/filters.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/filters.ts#L43"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.aggGeoHash","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggGeoHash","source":{"path":"src/plugins/data/common/search/aggs/buckets/geo_hash_fn.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_hash_fn.ts#L29"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getGeoHashBucketAgg","type":"Function","children":[],"signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BucketAggType","text":"BucketAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IBucketAggConfig","text":"IBucketAggConfig"},">"],"description":[],"label":"getGeoHashBucketAgg","source":{"path":"src/plugins/data/common/search/aggs/buckets/geo_hash.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_hash.ts#L37"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.aggGeoTile","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggGeoTile","source":{"path":"src/plugins/data/common/search/aggs/buckets/geo_tile_fn.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_tile_fn.ts#L26"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getGeoTitleBucketAgg","type":"Function","children":[],"signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BucketAggType","text":"BucketAggType"},""],"description":[],"label":"getGeoTitleBucketAgg","source":{"path":"src/plugins/data/common/search/aggs/buckets/geo_tile.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_tile.ts#L29"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.aggHistogram","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggHistogram","source":{"path":"src/plugins/data/common/search/aggs/buckets/histogram_fn.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram_fn.ts#L30"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getHistogramBucketAgg","type":"Function","children":[{"type":"Object","label":"{\n getConfig,\n getFieldFormatsStart,\n}","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.HistogramBucketAggDependencies","text":"HistogramBucketAggDependencies"}],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/histogram.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L51"}}],"signature":["({ getConfig, getFieldFormatsStart, }: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.HistogramBucketAggDependencies","text":"HistogramBucketAggDependencies"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BucketAggType","text":"BucketAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IBucketHistogramAggConfig","text":"IBucketHistogramAggConfig"},">"],"description":[],"label":"getHistogramBucketAgg","source":{"path":"src/plugins/data/common/search/aggs/buckets/histogram.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L51"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.aggIpRange","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggIpRange","source":{"path":"src/plugins/data/common/search/aggs/buckets/ip_range_fn.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/ip_range_fn.ts#L30"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getIpRangeBucketAgg","type":"Function","children":[],"signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BucketAggType","text":"BucketAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IBucketAggConfig","text":"IBucketAggConfig"},">"],"description":[],"label":"getIpRangeBucketAgg","source":{"path":"src/plugins/data/common/search/aggs/buckets/ip_range.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/ip_range.ts#L38"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.convertDateRangeToString","type":"Function","label":"convertDateRangeToString","signature":["({ from, to }: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.DateRangeKey","text":"DateRangeKey"},", format: (val: any) => string) => string"],"description":[],"children":[{"type":"Object","label":"{ from, to }","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.DateRangeKey","text":"DateRangeKey"}],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/date_range.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/date_range.ts#L14"}},{"type":"Function","label":"format","isRequired":true,"signature":["(val: any) => string"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/date_range.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/date_range.ts#L14"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/date_range.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/date_range.ts#L14"},"initialIsOpen":false},{"id":"def-common.convertIPRangeToString","type":"Function","children":[{"type":"CompoundType","label":"range","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IpRangeKey","text":"IpRangeKey"}],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L22"}},{"type":"Function","label":"format","isRequired":true,"signature":["(val: any) => string"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L22"}}],"signature":["(range: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IpRangeKey","text":"IpRangeKey"},", format: (val: any) => string) => string"],"description":[],"label":"convertIPRangeToString","source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L22"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.calcAutoIntervalNear","type":"Function","label":"calcAutoIntervalNear","signature":["(targetBucketCount: number, duration: number) => moment.Duration"],"description":["\nUsing some simple rules we pick a \"pretty\" interval that will\nproduce around the number of buckets desired given a time range.\n"],"children":[{"type":"number","label":"targetBucketCount","isRequired":true,"signature":["number"],"description":["desired number of buckets"],"source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts","lineNumber":225,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts#L225"}},{"type":"number","label":"duration","isRequired":true,"signature":["number"],"description":["time range the agg covers"],"source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts","lineNumber":225,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts#L225"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts","lineNumber":225,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts#L225"},"initialIsOpen":false},{"id":"def-common.calcAutoIntervalLessThan","type":"Function","label":"calcAutoIntervalLessThan","signature":["(maxBucketCount: number, duration: number) => moment.Duration"],"description":["\nPick a \"pretty\" interval that produces no more than the maxBucketCount\nfor the given time range.\n"],"children":[{"type":"number","label":"maxBucketCount","isRequired":true,"signature":["number"],"description":["maximum number of buckets to create"],"source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts","lineNumber":252,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts#L252"}},{"type":"number","label":"duration","isRequired":true,"signature":["number"],"description":["amount of time covered by the agg"],"source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts","lineNumber":252,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts#L252"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts","lineNumber":252,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts#L252"},"initialIsOpen":false},{"id":"def-common.isType","type":"Function","children":[{"type":"Array","label":"types","isRequired":true,"signature":["string[]"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts#L13"}}],"signature":["(...types: string[]) => (agg: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},") => boolean"],"description":[],"label":"isType","source":{"path":"src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts#L13"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.isNumberType","type":"Function","label":"isNumberType","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts#L21"},"signature":["(agg: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},") => boolean"],"initialIsOpen":false},{"id":"def-common.isStringType","type":"Function","label":"isStringType","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts#L22"},"signature":["(agg: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},") => boolean"],"initialIsOpen":false},{"id":"def-common.isStringOrNumberType","type":"Function","label":"isStringOrNumberType","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts#L23"},"signature":["(agg: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},") => boolean"],"initialIsOpen":false},{"id":"def-common.aggRange","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggRange","source":{"path":"src/plugins/data/common/search/aggs/buckets/range_fn.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/range_fn.ts#L30"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getRangeBucketAgg","type":"Function","children":[{"type":"Object","label":"{ getFieldFormatsStart }","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.RangeBucketAggDependencies","text":"RangeBucketAggDependencies"}],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/range.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/range.ts#L38"}}],"signature":["({ getFieldFormatsStart }: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.RangeBucketAggDependencies","text":"RangeBucketAggDependencies"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BucketAggType","text":"BucketAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IBucketAggConfig","text":"IBucketAggConfig"},">"],"description":[],"label":"getRangeBucketAgg","source":{"path":"src/plugins/data/common/search/aggs/buckets/range.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/range.ts#L38"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.aggSignificantTerms","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggSignificantTerms","source":{"path":"src/plugins/data/common/search/aggs/buckets/significant_terms_fn.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/significant_terms_fn.ts#L28"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getSignificantTermsBucketAgg","type":"Function","children":[],"signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BucketAggType","text":"BucketAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IBucketAggConfig","text":"IBucketAggConfig"},">"],"description":[],"label":"getSignificantTermsBucketAgg","source":{"path":"src/plugins/data/common/search/aggs/buckets/significant_terms.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/significant_terms.ts#L29"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.aggTerms","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggTerms","source":{"path":"src/plugins/data/common/search/aggs/buckets/terms_fn.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms_fn.ts#L31"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getTermsBucketAgg","type":"Function","children":[],"signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BucketAggType","text":"BucketAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IBucketAggConfig","text":"IBucketAggConfig"},">"],"description":[],"label":"getTermsBucketAgg","source":{"path":"src/plugins/data/common/search/aggs/buckets/terms.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms.ts#L65"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.aggAvg","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggAvg","source":{"path":"src/plugins/data/common/search/aggs/metrics/avg_fn.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/avg_fn.ts#L20"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getAvgMetricAgg","type":"Function","children":[],"signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggType","text":"MetricAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IMetricAggConfig","text":"IMetricAggConfig"},">"],"description":[],"label":"getAvgMetricAgg","source":{"path":"src/plugins/data/common/search/aggs/metrics/avg.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/avg.ts#L24"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.aggBucketAvg","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggBucketAvg","source":{"path":"src/plugins/data/common/search/aggs/metrics/bucket_avg_fn.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_avg_fn.ts#L30"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getBucketAvgMetricAgg","type":"Function","children":[],"signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggType","text":"MetricAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IMetricAggConfig","text":"IMetricAggConfig"},">"],"description":[],"label":"getBucketAvgMetricAgg","source":{"path":"src/plugins/data/common/search/aggs/metrics/bucket_avg.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_avg.ts#L31"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.aggBucketMax","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggBucketMax","source":{"path":"src/plugins/data/common/search/aggs/metrics/bucket_max_fn.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_max_fn.ts#L30"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getBucketMaxMetricAgg","type":"Function","children":[],"signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggType","text":"MetricAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IMetricAggConfig","text":"IMetricAggConfig"},">"],"description":[],"label":"getBucketMaxMetricAgg","source":{"path":"src/plugins/data/common/search/aggs/metrics/bucket_max.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_max.ts#L30"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.aggBucketMin","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggBucketMin","source":{"path":"src/plugins/data/common/search/aggs/metrics/bucket_min_fn.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_min_fn.ts#L30"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getBucketMinMetricAgg","type":"Function","children":[],"signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggType","text":"MetricAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IMetricAggConfig","text":"IMetricAggConfig"},">"],"description":[],"label":"getBucketMinMetricAgg","source":{"path":"src/plugins/data/common/search/aggs/metrics/bucket_min.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_min.ts#L30"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.aggBucketSum","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggBucketSum","source":{"path":"src/plugins/data/common/search/aggs/metrics/bucket_sum_fn.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_sum_fn.ts#L30"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getBucketSumMetricAgg","type":"Function","children":[],"signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggType","text":"MetricAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IMetricAggConfig","text":"IMetricAggConfig"},">"],"description":[],"label":"getBucketSumMetricAgg","source":{"path":"src/plugins/data/common/search/aggs/metrics/bucket_sum.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_sum.ts#L30"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.aggCardinality","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggCardinality","source":{"path":"src/plugins/data/common/search/aggs/metrics/cardinality_fn.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/cardinality_fn.ts#L25"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getCardinalityMetricAgg","type":"Function","children":[],"signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggType","text":"MetricAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IMetricAggConfig","text":"IMetricAggConfig"},">"],"description":[],"label":"getCardinalityMetricAgg","source":{"path":"src/plugins/data/common/search/aggs/metrics/cardinality.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/cardinality.ts#L24"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getCountMetricAgg","type":"Function","children":[],"signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggType","text":"MetricAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IMetricAggConfig","text":"IMetricAggConfig"},">"],"description":[],"label":"getCountMetricAgg","source":{"path":"src/plugins/data/common/search/aggs/metrics/count.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/count.ts#L14"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.aggCount","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggCount","source":{"path":"src/plugins/data/common/search/aggs/metrics/count_fn.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/count_fn.ts#L25"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.aggCumulativeSum","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggCumulativeSum","source":{"path":"src/plugins/data/common/search/aggs/metrics/cumulative_sum_fn.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/cumulative_sum_fn.ts#L27"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getCumulativeSumMetricAgg","type":"Function","children":[],"signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggType","text":"MetricAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IMetricAggConfig","text":"IMetricAggConfig"},">"],"description":[],"label":"getCumulativeSumMetricAgg","source":{"path":"src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/cumulative_sum.ts#L31"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.aggDerivative","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggDerivative","source":{"path":"src/plugins/data/common/search/aggs/metrics/derivative_fn.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/derivative_fn.ts#L27"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getDerivativeMetricAgg","type":"Function","children":[],"signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggType","text":"MetricAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IMetricAggConfig","text":"IMetricAggConfig"},">"],"description":[],"label":"getDerivativeMetricAgg","source":{"path":"src/plugins/data/common/search/aggs/metrics/derivative.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/derivative.ts#L31"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.aggGeoBounds","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggGeoBounds","source":{"path":"src/plugins/data/common/search/aggs/metrics/geo_bounds_fn.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/geo_bounds_fn.ts#L25"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getGeoBoundsMetricAgg","type":"Function","children":[],"signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggType","text":"MetricAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IMetricAggConfig","text":"IMetricAggConfig"},">"],"description":[],"label":"getGeoBoundsMetricAgg","source":{"path":"src/plugins/data/common/search/aggs/metrics/geo_bounds.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/geo_bounds.ts#L28"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.aggGeoCentroid","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggGeoCentroid","source":{"path":"src/plugins/data/common/search/aggs/metrics/geo_centroid_fn.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/geo_centroid_fn.ts#L25"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getGeoCentroidMetricAgg","type":"Function","children":[],"signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggType","text":"MetricAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IMetricAggConfig","text":"IMetricAggConfig"},">"],"description":[],"label":"getGeoCentroidMetricAgg","source":{"path":"src/plugins/data/common/search/aggs/metrics/geo_centroid.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/geo_centroid.ts#L28"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.aggMax","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggMax","source":{"path":"src/plugins/data/common/search/aggs/metrics/max_fn.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/max_fn.ts#L20"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getMaxMetricAgg","type":"Function","children":[],"signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggType","text":"MetricAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IMetricAggConfig","text":"IMetricAggConfig"},">"],"description":[],"label":"getMaxMetricAgg","source":{"path":"src/plugins/data/common/search/aggs/metrics/max.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/max.ts#L24"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.aggMedian","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggMedian","source":{"path":"src/plugins/data/common/search/aggs/metrics/median_fn.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/median_fn.ts#L25"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getMedianMetricAgg","type":"Function","children":[],"signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggType","text":"MetricAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IMetricAggConfig","text":"IMetricAggConfig"},">"],"description":[],"label":"getMedianMetricAgg","source":{"path":"src/plugins/data/common/search/aggs/metrics/median.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/median.ts#L24"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.isMetricAggType","type":"Function","label":"isMetricAggType","signature":["(aggConfig: any) => boolean"],"description":[],"children":[{"type":"Any","label":"aggConfig","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L75"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L75"},"initialIsOpen":false},{"id":"def-common.aggMin","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggMin","source":{"path":"src/plugins/data/common/search/aggs/metrics/min_fn.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/min_fn.ts#L20"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getMinMetricAgg","type":"Function","children":[],"signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggType","text":"MetricAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IMetricAggConfig","text":"IMetricAggConfig"},">"],"description":[],"label":"getMinMetricAgg","source":{"path":"src/plugins/data/common/search/aggs/metrics/min.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/min.ts#L24"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.aggMovingAvg","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggMovingAvg","source":{"path":"src/plugins/data/common/search/aggs/metrics/moving_avg_fn.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/moving_avg_fn.ts#L27"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getMovingAvgMetricAgg","type":"Function","children":[],"signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggType","text":"MetricAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IMetricAggConfig","text":"IMetricAggConfig"},">"],"description":[],"label":"getMovingAvgMetricAgg","source":{"path":"src/plugins/data/common/search/aggs/metrics/moving_avg.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/moving_avg.ts#L33"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.aggPercentileRanks","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggPercentileRanks","source":{"path":"src/plugins/data/common/search/aggs/metrics/percentile_ranks_fn.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentile_ranks_fn.ts#L25"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getPercentileRanksMetricAgg","type":"Function","children":[{"type":"Object","label":"{\n getFieldFormatsStart,\n}","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.PercentileRanksMetricAggDependencies","text":"PercentileRanksMetricAggDependencies"}],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentile_ranks.ts#L52"}}],"signature":["({ getFieldFormatsStart, }: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.PercentileRanksMetricAggDependencies","text":"PercentileRanksMetricAggDependencies"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggType","text":"MetricAggType"},"<","IResponseAggConfig",">"],"description":[],"label":"getPercentileRanksMetricAgg","source":{"path":"src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentile_ranks.ts#L52"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.aggPercentiles","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggPercentiles","source":{"path":"src/plugins/data/common/search/aggs/metrics/percentiles_fn.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentiles_fn.ts#L25"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getPercentilesMetricAgg","type":"Function","children":[],"signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggType","text":"MetricAggType"},"<","IResponseAggConfig",">"],"description":[],"label":"getPercentilesMetricAgg","source":{"path":"src/plugins/data/common/search/aggs/metrics/percentiles.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentiles.ts#L38"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.aggSerialDiff","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggSerialDiff","source":{"path":"src/plugins/data/common/search/aggs/metrics/serial_diff_fn.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/serial_diff_fn.ts#L27"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getSerialDiffMetricAgg","type":"Function","children":[],"signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggType","text":"MetricAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IMetricAggConfig","text":"IMetricAggConfig"},">"],"description":[],"label":"getSerialDiffMetricAgg","source":{"path":"src/plugins/data/common/search/aggs/metrics/serial_diff.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/serial_diff.ts#L31"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.aggStdDeviation","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggStdDeviation","source":{"path":"src/plugins/data/common/search/aggs/metrics/std_deviation_fn.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/std_deviation_fn.ts#L25"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getStdDeviationMetricAgg","type":"Function","children":[],"signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggType","text":"MetricAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IStdDevAggConfig","text":"IStdDevAggConfig"},">"],"description":[],"label":"getStdDeviationMetricAgg","source":{"path":"src/plugins/data/common/search/aggs/metrics/std_deviation.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/std_deviation.ts#L73"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.aggSum","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggSum","source":{"path":"src/plugins/data/common/search/aggs/metrics/sum_fn.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/sum_fn.ts#L20"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getSumMetricAgg","type":"Function","children":[],"signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggType","text":"MetricAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IMetricAggConfig","text":"IMetricAggConfig"},">"],"description":[],"label":"getSumMetricAgg","source":{"path":"src/plugins/data/common/search/aggs/metrics/sum.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/sum.ts#L24"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.aggTopHit","type":"Function","children":[],"signature":["() => FunctionDefinition"],"description":[],"label":"aggTopHit","source":{"path":"src/plugins/data/common/search/aggs/metrics/top_hit_fn.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/top_hit_fn.ts#L25"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getTopHitMetricAgg","type":"Function","children":[],"signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggType","text":"MetricAggType"},""],"description":[],"label":"getTopHitMetricAgg","source":{"path":"src/plugins/data/common/search/aggs/metrics/top_hit.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/top_hit.ts#L31"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getNumberHistogramIntervalByDatatableColumn","type":"Function","children":[{"type":"Object","label":"column","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.DatatableColumn","text":"DatatableColumn"}],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/get_number_histogram_interval.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/get_number_histogram_interval.ts#L19"}}],"signature":["(column: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.DatatableColumn","text":"DatatableColumn"},") => number | undefined"],"description":["\nHelper function returning the used interval for data table column created by the histogramm agg type.\n\"auto\" will get expanded to the actually used interval.\nIf the column is not a column created by a histogram aggregation of the esaggs data source,\nthis function will return undefined."],"label":"getNumberHistogramIntervalByDatatableColumn","source":{"path":"src/plugins/data/common/search/aggs/utils/get_number_histogram_interval.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/get_number_histogram_interval.ts#L19"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getCalculateAutoTimeExpression","type":"Function","label":"getCalculateAutoTimeExpression","signature":["(getConfig: (key: string) => any) => (range: ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"},") => string | undefined"],"description":[],"children":[{"type":"Function","label":"getConfig","isRequired":true,"signature":["(key: string) => any"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/calculate_auto_time_expression.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/calculate_auto_time_expression.ts#L16"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/calculate_auto_time_expression.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/calculate_auto_time_expression.ts#L16"},"initialIsOpen":false},{"id":"def-common.dateHistogramInterval","type":"Function","label":"dateHistogramInterval","signature":["(interval: string) => Interval"],"description":["\nChecks whether a given Elasticsearch interval is a calendar or fixed interval\nand returns an object containing the appropriate date_histogram property for that\ninterval. So it will return either an object containing the fixed_interval key for\nthat interval or a calendar_interval. If the specified interval was not a valid Elasticsearch\ninterval this method will throw an error.\n\nYou can simply spread the returned value of this method into your date_histogram."],"children":[{"type":"string","label":"interval","isRequired":true,"signature":["string"],"description":["The interval string to return the appropriate date_histogram key for."],"source":{"path":"src/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts#L31"}}],"tags":["example"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/date_histogram_interval.ts#L31"},"initialIsOpen":false},{"id":"def-common.isValidEsInterval","type":"Function","label":"isValidEsInterval","signature":["(interval: string) => boolean"],"description":["\nChecks whether a given interval string (e.g. 1w, 24h, ...) is a valid Elasticsearch interval.\nWill return false if the interval is not valid in Elasticsearch, otherwise true.\nInvalid intervals might be: 2f, since there is no unit 'f'; 2w, since weeks and month intervals\nare only allowed with a value of 1, etc.\n"],"children":[{"type":"string","label":"interval","isRequired":true,"signature":["string"],"description":["The interval string like 1w, 24h"],"source":{"path":"src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_es_interval.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_es_interval.ts#L20"}}],"tags":[],"returnComment":["True if the interval is valid for Elasticsearch"],"source":{"path":"src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_es_interval.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_es_interval.ts#L20"},"initialIsOpen":false},{"id":"def-common.isValidInterval","type":"Function","label":"isValidInterval","signature":["(value: string, baseInterval: string | undefined) => boolean"],"description":[],"children":[{"type":"string","label":"value","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts#L24"}},{"type":"string","label":"baseInterval","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts#L24"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/is_valid_interval.ts#L24"},"initialIsOpen":false},{"id":"def-common.parseInterval","type":"Function","label":"parseInterval","signature":["(interval: string) => moment.Duration | null"],"description":[],"children":[{"type":"string","label":"interval","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts#L29"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts#L29"},"initialIsOpen":false},{"id":"def-common.splitStringInterval","type":"Function","children":[{"type":"string","label":"interval","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts#L16"}}],"signature":["(interval: string) => { value: number; unit: ","Unit","; } | null"],"description":[],"label":"splitStringInterval","source":{"path":"src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/parse_interval.ts#L16"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.parseEsInterval","type":"Function","label":"parseEsInterval","signature":["(interval: string) => { value: number; unit: ","Unit","; type: \"calendar\" | \"fixed\"; }"],"description":["\nExtracts interval properties from an ES interval string. Disallows unrecognized interval formats\nand fractional values. Converts some intervals from \"calendar\" to \"fixed\" when the number of\nunits is larger than 1, and throws an error for others.\n\nConversion rules:\n\n| Interval | Single unit type | Multiple units type |\n| -------- | ---------------- | ------------------- |\n| ms | fixed | fixed |\n| s | fixed | fixed |\n| m | calendar | fixed |\n| h | calendar | fixed |\n| d | calendar | fixed |\n| w | calendar | N/A - disallowed |\n| M | calendar | N/A - disallowed |\n| y | calendar | N/A - disallowed |\n"],"children":[{"type":"string","label":"interval","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts#L39"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts#L39"},"initialIsOpen":false},{"id":"def-common.toAbsoluteDates","type":"Function","label":"toAbsoluteDates","signature":["(range: ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"},") => { from: Date; to: Date; } | undefined"],"description":[],"children":[{"type":"Object","label":"range","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"}],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts#L12"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/to_absolute_dates.ts#L12"},"initialIsOpen":false},{"id":"def-common.propFilter","type":"Function","label":"propFilter","signature":["(prop: P) => (list: T[], filters?: string | string[] | FilterFunc) => T[]"],"description":["\nFilters out a list by a given filter. This is currently used to implement:\n - fieldType filters a list of fields by their type property\n - aggFilter filters a list of aggs by their name property\n"],"children":[{"type":"Uncategorized","label":"prop","isRequired":true,"signature":["P"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/prop_filter.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/prop_filter.ts#L20"}}],"tags":[],"returnComment":["the filter function which can be registered with angular"],"source":{"path":"src/plugins/data/common/search/aggs/utils/prop_filter.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/prop_filter.ts#L20"},"initialIsOpen":false},{"id":"def-common.inferTimeZone","type":"Function","label":"inferTimeZone","signature":["(params: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsDateHistogram","text":"AggParamsDateHistogram"},", indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},", isDefaultTimezone: () => boolean, getConfig: (key: string) => T) => string"],"description":[],"children":[{"type":"Object","label":"params","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsDateHistogram","text":"AggParamsDateHistogram"}],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/infer_time_zone.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/infer_time_zone.ts#L14"}},{"type":"Object","label":"indexPattern","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/infer_time_zone.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/infer_time_zone.ts#L15"}},{"type":"Function","label":"isDefaultTimezone","isRequired":true,"signature":["() => boolean"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/infer_time_zone.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/infer_time_zone.ts#L16"}},{"type":"Function","label":"getConfig","isRequired":true,"signature":["(key: string) => T"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/infer_time_zone.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/infer_time_zone.ts#L17"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/infer_time_zone.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/infer_time_zone.ts#L13"},"initialIsOpen":false},{"id":"def-common.getEsaggsMeta","type":"Function","children":[],"signature":["() => { name: \"esaggs\"; type: \"datatable\"; inputTypes: (\"kibana_context\" | \"null\")[]; help: string; args: { index: { types: \"index_pattern\"[]; required: true; help: string; }; aggs: { types: \"agg_type\"[]; multi: true; default: never[]; help: string; }; metricsAtAllLevels: { types: \"boolean\"[]; default: false; help: string; }; partialRows: { types: \"boolean\"[]; default: false; help: string; }; timeFields: { types: \"string\"[]; multi: true; help: string; }; }; }"],"description":[],"label":"getEsaggsMeta","source":{"path":"src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#L51"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.handleRequest","type":"Function","children":[{"type":"Object","label":"{\n abortSignal,\n aggs,\n filters,\n indexPattern,\n inspectorAdapters,\n metricsAtAllLevels,\n partialRows,\n query,\n searchSessionId,\n searchSourceService,\n timeFields,\n timeRange,\n getNow,\n}","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.RequestHandlerParams","text":"RequestHandlerParams"}],"description":[],"source":{"path":"src/plugins/data/common/search/expressions/esaggs/request_handler.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/esaggs/request_handler.ts#L44"}}],"signature":["({ abortSignal, aggs, filters, indexPattern, inspectorAdapters, metricsAtAllLevels, partialRows, query, searchSessionId, searchSourceService, timeFields, timeRange, getNow, }: ","RequestHandlerParams",") => Promise<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"},">"],"description":[],"label":"handleRequest","source":{"path":"src/plugins/data/common/search/expressions/esaggs/request_handler.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/esaggs/request_handler.ts#L44"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getRequestInspectorStats","type":"Function","label":"getRequestInspectorStats","signature":["(searchSource: Pick<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"},", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">) => ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.RequestStatistics","text":"RequestStatistics"}],"description":[],"children":[{"type":"Object","label":"searchSource","isRequired":true,"signature":["Pick<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"},", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">"],"description":[],"source":{"path":"src/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts#L22"}}],"tags":["public"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts#L22"},"initialIsOpen":false},{"id":"def-common.getResponseInspectorStats","type":"Function","label":"getResponseInspectorStats","signature":["(resp: ","SearchResponse",", searchSource: Pick<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"},", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined) => ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.RequestStatistics","text":"RequestStatistics"}],"description":[],"children":[{"type":"Object","label":"resp","isRequired":true,"signature":["SearchResponse",""],"description":[],"source":{"path":"src/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts#L53"}},{"type":"Object","label":"searchSource","isRequired":false,"signature":["Pick<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"},", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\"> | undefined"],"description":[],"source":{"path":"src/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts#L54"}}],"tags":["public"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/utils/courier_inspector_stats.ts#L52"},"initialIsOpen":false},{"id":"def-common.functionWrapper","type":"Function","children":[{"type":"Object","label":"spec","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"}],"description":[],"source":{"path":"src/plugins/data/common/search/expressions/utils/function_wrapper.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/utils/function_wrapper.ts#L16"}}],"signature":["(spec: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"},") => (context: object | null, args?: Record, handlers?: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},"<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},">) => any"],"description":["\nTakes a function spec and passes in default args,\noverriding with any provided args."],"label":"functionWrapper","source":{"path":"src/plugins/data/common/search/expressions/utils/function_wrapper.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/utils/function_wrapper.ts#L16"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.createSearchSource","type":"Function","children":[{"type":"Object","label":"indexPatterns","isRequired":true,"signature":["Pick<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternsService","text":"IndexPatternsService"},", \"get\" | \"delete\" | \"create\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"find\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">"],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/create_search_source.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/create_search_source.ts#L32"}},{"type":"Object","label":"searchSourceDependencies","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceDependencies","text":"SearchSourceDependencies"}],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/create_search_source.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/create_search_source.ts#L33"}}],"signature":["(indexPatterns: Pick<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternsService","text":"IndexPatternsService"},", \"get\" | \"delete\" | \"create\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"find\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">, searchSourceDependencies: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceDependencies","text":"SearchSourceDependencies"},") => (searchSourceFields?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"},") => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"},">"],"description":["\nDeserializes a json string and a set of referenced objects to a `SearchSource` instance.\nUse this method to re-create the search source serialized using `searchSource.serialize`.\n\nThis function is a factory function that returns the actual utility when calling it with the\nrequired service dependency (index patterns contract). A pre-wired version is also exposed in\nthe start contract of the data plugin as part of the search service\n"],"label":"createSearchSource","source":{"path":"src/plugins/data/common/search/search_source/create_search_source.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/create_search_source.ts#L31"},"returnComment":["Wired utility function taking two parameters `searchSourceJson`, the json string\nreturned by `serializeSearchSource` and `references`, a list of references including the ones\nreturned by `serializeSearchSource`."],"initialIsOpen":false},{"id":"def-common.injectReferences","type":"Function","children":[{"type":"CompoundType","label":"searchSourceFields","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"}," & { indexRefName: string; }"],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/inject_references.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/inject_references.ts#L13"}},{"type":"Array","label":"references","isRequired":true,"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[]"],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/inject_references.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/inject_references.ts#L14"}}],"signature":["(searchSourceFields: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"}," & { indexRefName: string; }, references: ","SavedObjectReference","[]) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"}],"description":[],"label":"injectReferences","source":{"path":"src/plugins/data/common/search/search_source/inject_references.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/inject_references.ts#L12"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.extractReferences","type":"Function","children":[{"type":"Object","label":"state","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"}],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/extract_references.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/extract_references.ts#L14"}}],"signature":["(state: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"},") => [",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"}," & { indexRefName?: string | undefined; }, ","SavedObjectReference","[]]"],"description":[],"label":"extractReferences","source":{"path":"src/plugins/data/common/search/search_source/extract_references.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/extract_references.ts#L13"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.parseSearchSourceJSON","type":"Function","children":[{"type":"string","label":"searchSourceJSON","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/parse_json.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/parse_json.ts#L12"}}],"signature":["(searchSourceJSON: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"}],"description":[],"label":"parseSearchSourceJSON","source":{"path":"src/plugins/data/common/search/search_source/parse_json.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/parse_json.ts#L12"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getSearchParams","type":"Function","label":"getSearchParams","signature":["(getConfig: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.GetConfigFn","text":"GetConfigFn"},") => { preference: any; }"],"description":[],"children":[{"type":"Function","label":"getConfig","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.GetConfigFn","text":"GetConfigFn"}],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/fetch/get_search_params.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L16"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/fetch/get_search_params.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L16"},"initialIsOpen":false},{"id":"def-common.getSearchParamsFromRequest","type":"Function","label":"getSearchParamsFromRequest","signature":["(searchRequest: Record, dependencies: { getConfig: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.GetConfigFn","text":"GetConfigFn"},"; }) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchRequestParams","text":"ISearchRequestParams"},">"],"description":[],"children":[{"type":"Object","label":"searchRequest","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/fetch/get_search_params.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L34"}},{"id":"def-common.getSearchParamsFromRequest.dependencies","type":"Object","label":"dependencies","description":[],"children":[{"id":"def-common.getSearchParamsFromRequest.dependencies.getConfig","type":"Function","label":"getConfig","description":[],"source":{"path":"src/plugins/data/common/search/search_source/fetch/get_search_params.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L35"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.GetConfigFn","text":"GetConfigFn"}]}],"source":{"path":"src/plugins/data/common/search/search_source/fetch/get_search_params.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L35"}}],"tags":["public"],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/fetch/get_search_params.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L33"},"initialIsOpen":false},{"id":"def-common.getPreference","type":"Function","label":"getPreference","signature":["(getConfig: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.GetConfigFn","text":"GetConfigFn"},") => any"],"description":[],"children":[{"type":"Function","label":"getConfig","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.GetConfigFn","text":"GetConfigFn"}],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/fetch/get_search_params.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L22"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/fetch/get_search_params.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/get_search_params.ts#L22"},"initialIsOpen":false},{"id":"def-common.fetchSoon","type":"Function","label":"fetchSoon","signature":["(request: Record, options: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"},", fetchHandlers: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.FetchHandlers","text":"FetchHandlers"},") => Promise<","SearchResponse",">"],"description":["\nThis function introduces a slight delay in the request process to allow multiple requests to queue\nup (e.g. when a dashboard is loading)."],"children":[{"type":"Object","label":"request","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/legacy/fetch_soon.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/fetch_soon.ts#L20"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"}],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/legacy/fetch_soon.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/fetch_soon.ts#L21"}},{"type":"Object","label":"fetchHandlers","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.FetchHandlers","text":"FetchHandlers"}],"description":[],"source":{"path":"src/plugins/data/common/search/search_source/legacy/fetch_soon.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/fetch_soon.ts#L22"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/search_source/legacy/fetch_soon.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/fetch_soon.ts#L19"},"initialIsOpen":false},{"id":"def-common.tabify","type":"Function","children":[{"type":"Object","label":"searchSource","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"}],"description":[],"source":{"path":"src/plugins/data/common/search/tabify/index.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/tabify/index.ts#L16"}},{"type":"Object","label":"esResponse","isRequired":true,"signature":["SearchResponse",""],"description":[],"source":{"path":"src/plugins/data/common/search/tabify/index.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/tabify/index.ts#L17"}},{"type":"CompoundType","label":"opts","isRequired":true,"signature":["Partial<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.TabbedResponseWriterOptions","text":"TabbedResponseWriterOptions"},"> | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.TabifyDocsOptions","text":"TabifyDocsOptions"}],"description":[],"source":{"path":"src/plugins/data/common/search/tabify/index.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/tabify/index.ts#L18"}}],"signature":["(searchSource: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"},", esResponse: ","SearchResponse",", opts: Partial<","TabbedResponseWriterOptions","> | ","TabifyDocsOptions",") => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"}],"description":[],"label":"tabify","source":{"path":"src/plugins/data/common/search/tabify/index.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/tabify/index.ts#L15"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.tabifyDocs","type":"Function","children":[{"type":"Object","label":"esResponse","isRequired":true,"signature":["SearchResponse",""],"description":[],"source":{"path":"src/plugins/data/common/search/tabify/tabify_docs.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/tabify/tabify_docs.ts#L75"}},{"type":"Object","label":"index","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/search/tabify/tabify_docs.ts","lineNumber":76,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/tabify/tabify_docs.ts#L76"}},{"type":"Object","label":"params","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.TabifyDocsOptions","text":"TabifyDocsOptions"}],"description":[],"source":{"path":"src/plugins/data/common/search/tabify/tabify_docs.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/tabify/tabify_docs.ts#L77"}}],"signature":["(esResponse: ","SearchResponse",", index?: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}," | undefined, params?: ","TabifyDocsOptions",") => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"}],"description":[],"label":"tabifyDocs","source":{"path":"src/plugins/data/common/search/tabify/tabify_docs.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/tabify/tabify_docs.ts#L74"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.tabifyAggResponse","type":"Function","label":"tabifyAggResponse","signature":["(aggConfigs: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfigs","text":"AggConfigs"},", esResponse: Record, respOpts: Partial<","TabbedResponseWriterOptions","> | undefined) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"}],"description":["\nSets up the ResponseWriter and kicks off bucket collection."],"children":[{"type":"Object","label":"aggConfigs","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfigs","text":"AggConfigs"}],"description":[],"source":{"path":"src/plugins/data/common/search/tabify/tabify.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/tabify/tabify.ts#L20"}},{"type":"Object","label":"esResponse","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/data/common/search/tabify/tabify.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/tabify/tabify.ts#L21"}},{"type":"Object","label":"respOpts","isRequired":false,"signature":["Partial<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.TabbedResponseWriterOptions","text":"TabbedResponseWriterOptions"},"> | undefined"],"description":[],"source":{"path":"src/plugins/data/common/search/tabify/tabify.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/tabify/tabify.ts#L22"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/tabify/tabify.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/tabify/tabify.ts#L19"},"initialIsOpen":false},{"id":"def-common.tabifyGetColumns","type":"Function","label":"tabifyGetColumns","signature":["(aggs: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},"[], minimalColumns: boolean) => ","TabbedAggColumn","[]"],"description":["\nBuilds tabify columns.\n"],"children":[{"type":"Array","label":"aggs","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},"[]"],"description":["- the agg configs object to which the aggregation response correlates"],"source":{"path":"src/plugins/data/common/search/tabify/get_columns.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/tabify/get_columns.ts#L34"}},{"type":"boolean","label":"minimalColumns","isRequired":true,"signature":["boolean"],"description":["- setting to true will only return a column for the last bucket/metric instead of one for each level"],"source":{"path":"src/plugins/data/common/search/tabify/get_columns.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/tabify/get_columns.ts#L34"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/tabify/get_columns.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/tabify/get_columns.ts#L34"},"initialIsOpen":false},{"id":"def-common.isErrorResponse","type":"Function","children":[{"type":"Object","label":"response","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IKibanaSearchResponse","text":"IKibanaSearchResponse"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/search/utils.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/utils.ts#L14"}}],"signature":["(response?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IKibanaSearchResponse","text":"IKibanaSearchResponse"}," | undefined) => boolean | undefined"],"description":[],"label":"isErrorResponse","source":{"path":"src/plugins/data/common/search/utils.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/utils.ts#L14"},"returnComment":["true if response had an error while executing in ES"],"initialIsOpen":false},{"id":"def-common.isCompleteResponse","type":"Function","children":[{"type":"Object","label":"response","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IKibanaSearchResponse","text":"IKibanaSearchResponse"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/search/utils.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/utils.ts#L21"}}],"signature":["(response?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IKibanaSearchResponse","text":"IKibanaSearchResponse"}," | undefined) => boolean"],"description":[],"label":"isCompleteResponse","source":{"path":"src/plugins/data/common/search/utils.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/utils.ts#L21"},"returnComment":["true if response is completed successfully"],"initialIsOpen":false},{"id":"def-common.isPartialResponse","type":"Function","children":[{"type":"Object","label":"response","isRequired":false,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IKibanaSearchResponse","text":"IKibanaSearchResponse"}," | undefined"],"description":[],"source":{"path":"src/plugins/data/common/search/utils.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/utils.ts#L28"}}],"signature":["(response?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IKibanaSearchResponse","text":"IKibanaSearchResponse"}," | undefined) => boolean"],"description":[],"label":"isPartialResponse","source":{"path":"src/plugins/data/common/search/utils.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/utils.ts#L28"},"returnComment":["true if request is still running an/d response contains partial results"],"initialIsOpen":false}],"interfaces":[{"id":"def-common.SerializableState","type":"Interface","label":"SerializableState","description":[],"children":[{"id":"def-common.SerializableState.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L28"},"signature":["any"]}],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L27"},"initialIsOpen":false},{"id":"def-common.AggConfigsOptions","type":"Interface","label":"AggConfigsOptions","description":[],"children":[{"id":"def-common.AggConfigsOptions.typesRegistry","type":"Object","label":"typesRegistry","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L38"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggTypesRegistryStart","text":"AggTypesRegistryStart"}]}],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L37"},"initialIsOpen":false},{"id":"def-common.AggTypeConfig","type":"Interface","label":"AggTypeConfig","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggTypeConfig","text":"AggTypeConfig"},""],"description":[],"children":[{"id":"def-common.AggTypeConfig.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L26"}},{"id":"def-common.AggTypeConfig.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L27"}},{"id":"def-common.AggTypeConfig.createFilter","type":"Function","label":"createFilter","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L28"},"signature":["((aggConfig: TAggConfig, key: any, params?: any) => any) | undefined"]},{"id":"def-common.AggTypeConfig.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L29"},"signature":["string | undefined"]},{"id":"def-common.AggTypeConfig.dslName","type":"string","label":"dslName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L30"},"signature":["string | undefined"]},{"id":"def-common.AggTypeConfig.expressionName","type":"string","label":"expressionName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L31"}},{"id":"def-common.AggTypeConfig.makeLabel","type":"CompoundType","label":"makeLabel","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L32"},"signature":["((aggConfig: TAggConfig) => string) | (() => string) | undefined"]},{"id":"def-common.AggTypeConfig.ordered","type":"Any","label":"ordered","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L33"},"signature":["any"]},{"id":"def-common.AggTypeConfig.hasNoDsl","type":"CompoundType","label":"hasNoDsl","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L34"},"signature":["boolean | undefined"]},{"id":"def-common.AggTypeConfig.params","type":"Array","label":"params","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L35"},"signature":["Partial[] | undefined"]},{"id":"def-common.AggTypeConfig.valueType","type":"CompoundType","label":"valueType","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L36"},"signature":["\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\" | undefined"]},{"id":"def-common.AggTypeConfig.getRequestAggs","type":"CompoundType","label":"getRequestAggs","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L37"},"signature":["((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[]) | undefined"]},{"id":"def-common.AggTypeConfig.getResponseAggs","type":"CompoundType","label":"getResponseAggs","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L38"},"signature":["((aggConfig: TAggConfig) => TAggConfig[]) | (() => void | TAggConfig[]) | undefined"]},{"id":"def-common.AggTypeConfig.customLabels","type":"CompoundType","label":"customLabels","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L39"},"signature":["boolean | undefined"]},{"id":"def-common.AggTypeConfig.json","type":"CompoundType","label":"json","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L40"},"signature":["boolean | undefined"]},{"id":"def-common.AggTypeConfig.decorateAggConfig","type":"Function","label":"decorateAggConfig","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L41"},"signature":["(() => any) | undefined"]},{"id":"def-common.AggTypeConfig.postFlightRequest","type":"Function","label":"postFlightRequest","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L42"},"signature":["((resp: any, aggConfigs: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfigs","text":"AggConfigs"},", aggConfig: TAggConfig, searchSource: Pick<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"},", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">, inspectorRequestAdapter?: ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.RequestAdapter","text":"RequestAdapter"}," | undefined, abortSignal?: AbortSignal | undefined, searchSessionId?: string | undefined) => Promise) | undefined"]},{"id":"def-common.AggTypeConfig.getSerializedFormat","type":"Function","label":"getSerializedFormat","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L51"},"signature":["((agg: TAggConfig) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializedFieldFormat","text":"SerializedFieldFormat"},">) | undefined"]},{"id":"def-common.AggTypeConfig.getValue","type":"Function","label":"getValue","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L52"},"signature":["((agg: TAggConfig, bucket: any) => any) | undefined"]},{"id":"def-common.AggTypeConfig.getKey","type":"Function","label":"getKey","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L53"},"signature":["((bucket: any, key: any, agg: TAggConfig) => any) | undefined"]},{"id":"def-common.AggTypeConfig.getValueBucketPath","type":"Function","label":"getValueBucketPath","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L54"},"signature":["((agg: TAggConfig) => string) | undefined"]}],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L22"},"initialIsOpen":false},{"id":"def-common.AggTypesDependencies","type":"Interface","label":"AggTypesDependencies","description":[],"children":[{"id":"def-common.AggTypesDependencies.calculateBounds","type":"Function","label":"calculateBounds","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_types.ts#L19"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.CalculateBoundsFn","text":"CalculateBoundsFn"}]},{"id":"def-common.AggTypesDependencies.getConfig","type":"Function","label":"getConfig","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_types.ts#L20"},"signature":["(key: string) => T"]},{"id":"def-common.AggTypesDependencies.getFieldFormatsStart","type":"Function","label":"getFieldFormatsStart","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_types.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_types.ts#L21"},"signature":["() => Pick, \"deserialize\" | \"getDefaultInstance\">"]},{"id":"def-common.AggTypesDependencies.isDefaultTimezone","type":"Function","label":"isDefaultTimezone","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_types.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_types.ts#L22"},"signature":["() => boolean"]}],"source":{"path":"src/plugins/data/common/search/aggs/agg_types.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_types.ts#L18"},"initialIsOpen":false},{"id":"def-common.AggTypesRegistryStart","type":"Interface","label":"AggTypesRegistryStart","description":["\nAggsCommonStart returns the _unitialized_ agg type providers, but in our\nreal start contract we will need to return the initialized versions.\nSo we need to provide the correct typings so they can be overwritten\non client/server.\n"],"children":[{"id":"def-common.AggTypesRegistryStart.get","type":"Function","label":"get","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_types_registry.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_types_registry.ts#L23"},"signature":["(id: string) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BucketAggType","text":"BucketAggType"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggType","text":"MetricAggType"},""]},{"id":"def-common.AggTypesRegistryStart.getAll","type":"Function","label":"getAll","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_types_registry.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_types_registry.ts#L24"},"signature":["() => { buckets: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BucketAggType","text":"BucketAggType"},"[]; metrics: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggType","text":"MetricAggType"},"[]; }"]}],"source":{"path":"src/plugins/data/common/search/aggs/agg_types_registry.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_types_registry.ts#L22"},"initialIsOpen":false},{"id":"def-common.AggsCommonSetupDependencies","type":"Interface","label":"AggsCommonSetupDependencies","description":[],"children":[{"id":"def-common.AggsCommonSetupDependencies.registerFunction","type":"Function","label":"registerFunction","description":[],"source":{"path":"src/plugins/data/common/search/aggs/aggs_service.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/aggs_service.ts#L38"},"signature":["(functionDefinition: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"},")) => void"]}],"source":{"path":"src/plugins/data/common/search/aggs/aggs_service.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/aggs_service.ts#L37"},"initialIsOpen":false},{"id":"def-common.AggsCommonStartDependencies","type":"Interface","label":"AggsCommonStartDependencies","description":[],"children":[{"id":"def-common.AggsCommonStartDependencies.getConfig","type":"Function","label":"getConfig","description":[],"source":{"path":"src/plugins/data/common/search/aggs/aggs_service.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/aggs_service.ts#L43"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.GetConfigFn","text":"GetConfigFn"}]},{"id":"def-common.AggsCommonStartDependencies.getIndexPattern","type":"Function","label":"getIndexPattern","signature":["(id: string) => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},">"],"description":[],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/aggs_service.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/aggs_service.ts#L44"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/aggs_service.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/aggs_service.ts#L44"}},{"id":"def-common.AggsCommonStartDependencies.isDefaultTimezone","type":"Function","label":"isDefaultTimezone","description":[],"source":{"path":"src/plugins/data/common/search/aggs/aggs_service.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/aggs_service.ts#L45"},"signature":["() => boolean"]}],"source":{"path":"src/plugins/data/common/search/aggs/aggs_service.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/aggs_service.ts#L42"},"initialIsOpen":false},{"id":"def-common.IBucketAggConfig","type":"Interface","label":"IBucketAggConfig","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IBucketAggConfig","text":"IBucketAggConfig"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"}],"description":[],"children":[{"id":"def-common.IBucketAggConfig.type","type":"Object","label":"type","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L15"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BucketAggType","text":"BucketAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},">"]}],"source":{"path":"src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L14"},"initialIsOpen":false},{"id":"def-common.BucketAggParam","type":"Interface","label":"BucketAggParam","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BucketAggParam","text":"BucketAggParam"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamType","text":"AggParamType"},""],"description":[],"children":[{"id":"def-common.BucketAggParam.scriptable","type":"CompoundType","label":"scriptable","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L20"},"signature":["boolean | undefined"]},{"id":"def-common.BucketAggParam.filterFieldTypes","type":"CompoundType","label":"filterFieldTypes","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L21"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"}," | \"*\" | ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"},"[] | undefined"]}],"source":{"path":"src/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/bucket_agg_type.ts#L18"},"initialIsOpen":false},{"id":"def-common.DateHistogramBucketAggDependencies","type":"Interface","label":"DateHistogramBucketAggDependencies","description":[],"children":[{"id":"def-common.DateHistogramBucketAggDependencies.calculateBounds","type":"Function","label":"calculateBounds","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_histogram.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L48"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.CalculateBoundsFn","text":"CalculateBoundsFn"}]},{"id":"def-common.DateHistogramBucketAggDependencies.isDefaultTimezone","type":"Function","label":"isDefaultTimezone","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_histogram.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L49"},"signature":["() => boolean"]},{"id":"def-common.DateHistogramBucketAggDependencies.getConfig","type":"Function","label":"getConfig","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_histogram.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L50"},"signature":["(key: string) => T"]}],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_histogram.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L47"},"initialIsOpen":false},{"id":"def-common.IBucketDateHistogramAggConfig","type":"Interface","label":"IBucketDateHistogramAggConfig","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IBucketDateHistogramAggConfig","text":"IBucketDateHistogramAggConfig"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IBucketAggConfig","text":"IBucketAggConfig"}],"description":[],"children":[{"id":"def-common.IBucketDateHistogramAggConfig.buckets","type":"Object","label":"buckets","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_histogram.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L54"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.TimeBuckets","text":"TimeBuckets"}]}],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_histogram.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L53"},"initialIsOpen":false},{"id":"def-common.AggParamsDateHistogram","type":"Interface","label":"AggParamsDateHistogram","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsDateHistogram","text":"AggParamsDateHistogram"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}],"description":[],"children":[{"id":"def-common.AggParamsDateHistogram.field","type":"CompoundType","label":"field","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_histogram.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L62"},"signature":["string | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}," | undefined"]},{"id":"def-common.AggParamsDateHistogram.timeRange","type":"Object","label":"timeRange","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_histogram.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L63"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"}," | undefined"]},{"id":"def-common.AggParamsDateHistogram.useNormalizedEsInterval","type":"CompoundType","label":"useNormalizedEsInterval","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_histogram.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L64"},"signature":["boolean | undefined"]},{"id":"def-common.AggParamsDateHistogram.scaleMetricValues","type":"CompoundType","label":"scaleMetricValues","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_histogram.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L65"},"signature":["boolean | undefined"]},{"id":"def-common.AggParamsDateHistogram.interval","type":"string","label":"interval","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_histogram.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L66"},"signature":["string | undefined"]},{"id":"def-common.AggParamsDateHistogram.time_zone","type":"string","label":"time_zone","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_histogram.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L67"},"signature":["string | undefined"]},{"id":"def-common.AggParamsDateHistogram.drop_partials","type":"CompoundType","label":"drop_partials","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_histogram.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L68"},"signature":["boolean | undefined"]},{"id":"def-common.AggParamsDateHistogram.format","type":"string","label":"format","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_histogram.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L69"},"signature":["string | undefined"]},{"id":"def-common.AggParamsDateHistogram.min_doc_count","type":"number","label":"min_doc_count","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_histogram.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L70"},"signature":["number | undefined"]},{"id":"def-common.AggParamsDateHistogram.extended_bounds","type":"Object","label":"extended_bounds","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_histogram.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L71"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ExtendedBounds","text":"ExtendedBounds"}," | undefined"]}],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_histogram.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L61"},"initialIsOpen":false},{"id":"def-common.DateRangeBucketAggDependencies","type":"Interface","label":"DateRangeBucketAggDependencies","description":[],"children":[{"id":"def-common.DateRangeBucketAggDependencies.isDefaultTimezone","type":"Function","label":"isDefaultTimezone","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_range.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_range.ts#L27"},"signature":["() => boolean"]},{"id":"def-common.DateRangeBucketAggDependencies.getConfig","type":"Function","label":"getConfig","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_range.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_range.ts#L28"},"signature":["(key: string) => T"]}],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_range.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_range.ts#L26"},"initialIsOpen":false},{"id":"def-common.AggParamsDateRange","type":"Interface","label":"AggParamsDateRange","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsDateRange","text":"AggParamsDateRange"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}],"description":[],"children":[{"id":"def-common.AggParamsDateRange.field","type":"string","label":"field","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_range.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_range.ts#L32"},"signature":["string | undefined"]},{"id":"def-common.AggParamsDateRange.ranges","type":"Array","label":"ranges","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_range.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_range.ts#L33"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.DateRangeKey","text":"DateRangeKey"},"[] | undefined"]},{"id":"def-common.AggParamsDateRange.time_zone","type":"string","label":"time_zone","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_range.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_range.ts#L34"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_range.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_range.ts#L31"},"initialIsOpen":false},{"id":"def-common.AggParamsFilter","type":"Interface","label":"AggParamsFilter","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsFilter","text":"AggParamsFilter"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}],"description":[],"children":[{"id":"def-common.AggParamsFilter.geo_bounding_box","type":"CompoundType","label":"geo_bounding_box","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/filter.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/filter.ts#L21"},"signature":["Partial<{ top_left: GeoPoint; top_right: GeoPoint; bottom_right: GeoPoint; bottom_left: GeoPoint; }> | { wkt: string; } | GeoBox | undefined"]}],"source":{"path":"src/plugins/data/common/search/aggs/buckets/filter.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/filter.ts#L20"},"initialIsOpen":false},{"id":"def-common.FiltersBucketAggDependencies","type":"Interface","label":"FiltersBucketAggDependencies","description":[],"children":[{"id":"def-common.FiltersBucketAggDependencies.getConfig","type":"Function","label":"getConfig","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/filters.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/filters.ts#L33"},"signature":["(key: string) => any"]}],"source":{"path":"src/plugins/data/common/search/aggs/buckets/filters.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/filters.ts#L32"},"initialIsOpen":false},{"id":"def-common.AggParamsFilters","type":"Interface","label":"AggParamsFilters","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsFilters","text":"AggParamsFilters"}," extends Pick<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"},", \"json\">"],"description":[],"children":[{"id":"def-common.AggParamsFilters.filters","type":"Array","label":"filters","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/filters.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/filters.ts#L37"},"signature":["{ input: ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.Query","text":"Query"},"; label: string; }[] | undefined"]}],"source":{"path":"src/plugins/data/common/search/aggs/buckets/filters.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/filters.ts#L36"},"initialIsOpen":false},{"id":"def-common.AggParamsGeoHash","type":"Interface","label":"AggParamsGeoHash","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsGeoHash","text":"AggParamsGeoHash"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}],"description":[],"children":[{"id":"def-common.AggParamsGeoHash.field","type":"string","label":"field","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/geo_hash.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_hash.ts#L29"}},{"id":"def-common.AggParamsGeoHash.autoPrecision","type":"CompoundType","label":"autoPrecision","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/geo_hash.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_hash.ts#L30"},"signature":["boolean | undefined"]},{"id":"def-common.AggParamsGeoHash.precision","type":"number","label":"precision","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/geo_hash.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_hash.ts#L31"},"signature":["number | undefined"]},{"id":"def-common.AggParamsGeoHash.useGeocentroid","type":"CompoundType","label":"useGeocentroid","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/geo_hash.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_hash.ts#L32"},"signature":["boolean | undefined"]},{"id":"def-common.AggParamsGeoHash.isFilteredByCollar","type":"CompoundType","label":"isFilteredByCollar","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/geo_hash.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_hash.ts#L33"},"signature":["boolean | undefined"]},{"id":"def-common.AggParamsGeoHash.boundingBox","type":"CompoundType","label":"boundingBox","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/geo_hash.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_hash.ts#L34"},"signature":["Partial<{ top_left: GeoPoint; top_right: GeoPoint; bottom_right: GeoPoint; bottom_left: GeoPoint; }> | { wkt: string; } | GeoBox | undefined"]}],"source":{"path":"src/plugins/data/common/search/aggs/buckets/geo_hash.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_hash.ts#L28"},"initialIsOpen":false},{"id":"def-common.AggParamsGeoTile","type":"Interface","label":"AggParamsGeoTile","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsGeoTile","text":"AggParamsGeoTile"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}],"description":[],"children":[{"id":"def-common.AggParamsGeoTile.field","type":"string","label":"field","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/geo_tile.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_tile.ts#L24"}},{"id":"def-common.AggParamsGeoTile.useGeocentroid","type":"CompoundType","label":"useGeocentroid","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/geo_tile.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_tile.ts#L25"},"signature":["boolean | undefined"]},{"id":"def-common.AggParamsGeoTile.precision","type":"number","label":"precision","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/geo_tile.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_tile.ts#L26"},"signature":["number | undefined"]}],"source":{"path":"src/plugins/data/common/search/aggs/buckets/geo_tile.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_tile.ts#L23"},"initialIsOpen":false},{"id":"def-common.AutoBounds","type":"Interface","label":"AutoBounds","description":[],"children":[{"id":"def-common.AutoBounds.min","type":"number","label":"min","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/histogram.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L26"}},{"id":"def-common.AutoBounds.max","type":"number","label":"max","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/histogram.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L27"}}],"source":{"path":"src/plugins/data/common/search/aggs/buckets/histogram.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L25"},"initialIsOpen":false},{"id":"def-common.HistogramBucketAggDependencies","type":"Interface","label":"HistogramBucketAggDependencies","description":[],"children":[{"id":"def-common.HistogramBucketAggDependencies.getConfig","type":"Function","label":"getConfig","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/histogram.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L31"},"signature":["(key: string) => T"]},{"id":"def-common.HistogramBucketAggDependencies.getFieldFormatsStart","type":"Function","label":"getFieldFormatsStart","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/histogram.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L32"},"signature":["() => Pick, \"deserialize\" | \"getDefaultInstance\">"]}],"source":{"path":"src/plugins/data/common/search/aggs/buckets/histogram.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L30"},"initialIsOpen":false},{"id":"def-common.IBucketHistogramAggConfig","type":"Interface","label":"IBucketHistogramAggConfig","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IBucketHistogramAggConfig","text":"IBucketHistogramAggConfig"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IBucketAggConfig","text":"IBucketAggConfig"}],"description":[],"children":[{"id":"def-common.IBucketHistogramAggConfig.setAutoBounds","type":"Function","label":"setAutoBounds","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/histogram.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L36"},"signature":["(bounds: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AutoBounds","text":"AutoBounds"},") => void"]},{"id":"def-common.IBucketHistogramAggConfig.getAutoBounds","type":"Function","label":"getAutoBounds","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/histogram.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L37"},"signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AutoBounds","text":"AutoBounds"}]}],"source":{"path":"src/plugins/data/common/search/aggs/buckets/histogram.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L35"},"initialIsOpen":false},{"id":"def-common.AggParamsHistogram","type":"Interface","label":"AggParamsHistogram","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsHistogram","text":"AggParamsHistogram"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}],"description":[],"children":[{"id":"def-common.AggParamsHistogram.field","type":"string","label":"field","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/histogram.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L41"}},{"id":"def-common.AggParamsHistogram.interval","type":"CompoundType","label":"interval","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/histogram.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L42"},"signature":["React.ReactText"]},{"id":"def-common.AggParamsHistogram.used_interval","type":"CompoundType","label":"used_interval","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/histogram.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L43"},"signature":["string | number | undefined"]},{"id":"def-common.AggParamsHistogram.maxBars","type":"number","label":"maxBars","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/histogram.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L44"},"signature":["number | undefined"]},{"id":"def-common.AggParamsHistogram.intervalBase","type":"number","label":"intervalBase","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/histogram.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L45"},"signature":["number | undefined"]},{"id":"def-common.AggParamsHistogram.min_doc_count","type":"CompoundType","label":"min_doc_count","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/histogram.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L46"},"signature":["boolean | undefined"]},{"id":"def-common.AggParamsHistogram.has_extended_bounds","type":"CompoundType","label":"has_extended_bounds","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/histogram.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L47"},"signature":["boolean | undefined"]},{"id":"def-common.AggParamsHistogram.extended_bounds","type":"Object","label":"extended_bounds","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/histogram.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L48"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ExtendedBounds","text":"ExtendedBounds"}," | undefined"]}],"source":{"path":"src/plugins/data/common/search/aggs/buckets/histogram.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram.ts#L40"},"initialIsOpen":false},{"id":"def-common.AggParamsIpRange","type":"Interface","label":"AggParamsIpRange","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsIpRange","text":"AggParamsIpRange"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}],"description":[],"children":[{"id":"def-common.AggParamsIpRange.field","type":"string","label":"field","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/ip_range.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/ip_range.ts#L30"}},{"id":"def-common.AggParamsIpRange.ipRangeType","type":"CompoundType","label":"ipRangeType","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/ip_range.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/ip_range.ts#L31"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IP_RANGE_TYPES","text":"IP_RANGE_TYPES"}," | undefined"]},{"id":"def-common.AggParamsIpRange.ranges","type":"Object","label":"ranges","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/ip_range.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/ip_range.ts#L32"},"signature":["Partial<{ fromTo: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.RangeIpRangeAggKey","text":"RangeIpRangeAggKey"},"[]; mask: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.CidrMaskIpRangeAggKey","text":"CidrMaskIpRangeAggKey"},"[]; }> | undefined"]}],"source":{"path":"src/plugins/data/common/search/aggs/buckets/ip_range.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/ip_range.ts#L29"},"initialIsOpen":false},{"id":"def-common.DateRangeKey","type":"Interface","label":"DateRangeKey","description":[],"children":[{"id":"def-common.DateRangeKey.from","type":"CompoundType","label":"from","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/date_range.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/date_range.ts#L10"},"signature":["React.ReactText"]},{"id":"def-common.DateRangeKey.to","type":"CompoundType","label":"to","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/date_range.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/date_range.ts#L11"},"signature":["React.ReactText"]}],"source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/date_range.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/date_range.ts#L9"},"initialIsOpen":false},{"id":"def-common.CidrMaskIpRangeAggKey","type":"Interface","label":"CidrMaskIpRangeAggKey","description":[],"children":[{"id":"def-common.CidrMaskIpRangeAggKey.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L10"},"signature":["\"mask\""]},{"id":"def-common.CidrMaskIpRangeAggKey.mask","type":"string","label":"mask","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L11"}}],"source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L9"},"initialIsOpen":false},{"id":"def-common.RangeIpRangeAggKey","type":"Interface","label":"RangeIpRangeAggKey","description":[],"children":[{"id":"def-common.RangeIpRangeAggKey.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L15"},"signature":["\"range\""]},{"id":"def-common.RangeIpRangeAggKey.from","type":"string","label":"from","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L16"}},{"id":"def-common.RangeIpRangeAggKey.to","type":"string","label":"to","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L17"}}],"source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L14"},"initialIsOpen":false},{"id":"def-common.RangeBucketAggDependencies","type":"Interface","label":"RangeBucketAggDependencies","description":[],"children":[{"id":"def-common.RangeBucketAggDependencies.getFieldFormatsStart","type":"Function","label":"getFieldFormatsStart","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/range.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/range.ts#L26"},"signature":["() => Pick, \"deserialize\" | \"getDefaultInstance\">"]}],"source":{"path":"src/plugins/data/common/search/aggs/buckets/range.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/range.ts#L25"},"initialIsOpen":false},{"id":"def-common.AggParamsRange","type":"Interface","label":"AggParamsRange","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsRange","text":"AggParamsRange"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}],"description":[],"children":[{"id":"def-common.AggParamsRange.field","type":"string","label":"field","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/range.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/range.ts#L30"}},{"id":"def-common.AggParamsRange.ranges","type":"Array","label":"ranges","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/range.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/range.ts#L31"},"signature":["{ from: number; to: number; label?: string | undefined; }[] | undefined"]}],"source":{"path":"src/plugins/data/common/search/aggs/buckets/range.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/range.ts#L29"},"initialIsOpen":false},{"id":"def-common.AggParamsSignificantTerms","type":"Interface","label":"AggParamsSignificantTerms","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsSignificantTerms","text":"AggParamsSignificantTerms"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}],"description":[],"children":[{"id":"def-common.AggParamsSignificantTerms.field","type":"string","label":"field","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/significant_terms.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/significant_terms.ts#L23"}},{"id":"def-common.AggParamsSignificantTerms.size","type":"number","label":"size","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/significant_terms.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/significant_terms.ts#L24"},"signature":["number | undefined"]},{"id":"def-common.AggParamsSignificantTerms.exclude","type":"string","label":"exclude","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/significant_terms.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/significant_terms.ts#L25"},"signature":["string | undefined"]},{"id":"def-common.AggParamsSignificantTerms.include","type":"string","label":"include","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/significant_terms.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/significant_terms.ts#L26"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/data/common/search/aggs/buckets/significant_terms.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/significant_terms.ts#L22"},"initialIsOpen":false},{"id":"def-common.AggParamsTerms","type":"Interface","label":"AggParamsTerms","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsTerms","text":"AggParamsTerms"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}],"description":[],"children":[{"id":"def-common.AggParamsTerms.field","type":"string","label":"field","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/terms.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms.ts#L51"}},{"id":"def-common.AggParamsTerms.orderBy","type":"string","label":"orderBy","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/terms.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms.ts#L52"}},{"id":"def-common.AggParamsTerms.orderAgg","type":"Object","label":"orderAgg","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/terms.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms.ts#L53"},"signature":["{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined; schema?: string | undefined; } | undefined"]},{"id":"def-common.AggParamsTerms.order","type":"CompoundType","label":"order","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/terms.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms.ts#L54"},"signature":["\"asc\" | \"desc\" | undefined"]},{"id":"def-common.AggParamsTerms.size","type":"number","label":"size","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/terms.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms.ts#L55"},"signature":["number | undefined"]},{"id":"def-common.AggParamsTerms.missingBucket","type":"CompoundType","label":"missingBucket","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/terms.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms.ts#L56"},"signature":["boolean | undefined"]},{"id":"def-common.AggParamsTerms.missingBucketLabel","type":"string","label":"missingBucketLabel","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/terms.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms.ts#L57"},"signature":["string | undefined"]},{"id":"def-common.AggParamsTerms.otherBucket","type":"CompoundType","label":"otherBucket","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/terms.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms.ts#L58"},"signature":["boolean | undefined"]},{"id":"def-common.AggParamsTerms.otherBucketLabel","type":"string","label":"otherBucketLabel","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/terms.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms.ts#L59"},"signature":["string | undefined"]},{"id":"def-common.AggParamsTerms.exclude","type":"string","label":"exclude","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/terms.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms.ts#L61"},"signature":["string | undefined"]},{"id":"def-common.AggParamsTerms.include","type":"string","label":"include","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/terms.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms.ts#L62"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/data/common/search/aggs/buckets/terms.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms.ts#L50"},"initialIsOpen":false},{"id":"def-common.AggParamsAvg","type":"Interface","label":"AggParamsAvg","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsAvg","text":"AggParamsAvg"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}],"description":[],"children":[{"id":"def-common.AggParamsAvg.field","type":"string","label":"field","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/avg.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/avg.ts#L21"}}],"source":{"path":"src/plugins/data/common/search/aggs/metrics/avg.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/avg.ts#L20"},"initialIsOpen":false},{"id":"def-common.AggParamsBucketAvg","type":"Interface","label":"AggParamsBucketAvg","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsBucketAvg","text":"AggParamsBucketAvg"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}],"description":[],"children":[{"id":"def-common.AggParamsBucketAvg.customMetric","type":"Object","label":"customMetric","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/bucket_avg.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_avg.ts#L19"},"signature":["{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined; schema?: string | undefined; } | undefined"]},{"id":"def-common.AggParamsBucketAvg.customBucket","type":"Object","label":"customBucket","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/bucket_avg.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_avg.ts#L20"},"signature":["{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined; schema?: string | undefined; } | undefined"]}],"source":{"path":"src/plugins/data/common/search/aggs/metrics/bucket_avg.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_avg.ts#L18"},"initialIsOpen":false},{"id":"def-common.AggParamsBucketMax","type":"Interface","label":"AggParamsBucketMax","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsBucketMax","text":"AggParamsBucketMax"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}],"description":[],"children":[{"id":"def-common.AggParamsBucketMax.customMetric","type":"Object","label":"customMetric","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/bucket_max.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_max.ts#L18"},"signature":["{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined; schema?: string | undefined; } | undefined"]},{"id":"def-common.AggParamsBucketMax.customBucket","type":"Object","label":"customBucket","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/bucket_max.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_max.ts#L19"},"signature":["{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined; schema?: string | undefined; } | undefined"]}],"source":{"path":"src/plugins/data/common/search/aggs/metrics/bucket_max.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_max.ts#L17"},"initialIsOpen":false},{"id":"def-common.AggParamsBucketMin","type":"Interface","label":"AggParamsBucketMin","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsBucketMin","text":"AggParamsBucketMin"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}],"description":[],"children":[{"id":"def-common.AggParamsBucketMin.customMetric","type":"Object","label":"customMetric","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/bucket_min.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_min.ts#L18"},"signature":["{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined; schema?: string | undefined; } | undefined"]},{"id":"def-common.AggParamsBucketMin.customBucket","type":"Object","label":"customBucket","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/bucket_min.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_min.ts#L19"},"signature":["{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined; schema?: string | undefined; } | undefined"]}],"source":{"path":"src/plugins/data/common/search/aggs/metrics/bucket_min.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_min.ts#L17"},"initialIsOpen":false},{"id":"def-common.AggParamsBucketSum","type":"Interface","label":"AggParamsBucketSum","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsBucketSum","text":"AggParamsBucketSum"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}],"description":[],"children":[{"id":"def-common.AggParamsBucketSum.customMetric","type":"Object","label":"customMetric","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/bucket_sum.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_sum.ts#L18"},"signature":["{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined; schema?: string | undefined; } | undefined"]},{"id":"def-common.AggParamsBucketSum.customBucket","type":"Object","label":"customBucket","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/bucket_sum.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_sum.ts#L19"},"signature":["{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined; schema?: string | undefined; } | undefined"]}],"source":{"path":"src/plugins/data/common/search/aggs/metrics/bucket_sum.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_sum.ts#L17"},"initialIsOpen":false},{"id":"def-common.AggParamsCardinality","type":"Interface","label":"AggParamsCardinality","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsCardinality","text":"AggParamsCardinality"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}],"description":[],"children":[{"id":"def-common.AggParamsCardinality.field","type":"string","label":"field","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/cardinality.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/cardinality.ts#L21"}}],"source":{"path":"src/plugins/data/common/search/aggs/metrics/cardinality.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/cardinality.ts#L20"},"initialIsOpen":false},{"id":"def-common.AggParamsCumulativeSum","type":"Interface","label":"AggParamsCumulativeSum","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsCumulativeSum","text":"AggParamsCumulativeSum"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}],"description":[],"children":[{"id":"def-common.AggParamsCumulativeSum.buckets_path","type":"string","label":"buckets_path","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/cumulative_sum.ts#L18"},"signature":["string | undefined"]},{"id":"def-common.AggParamsCumulativeSum.customMetric","type":"Object","label":"customMetric","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/cumulative_sum.ts#L19"},"signature":["{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined; schema?: string | undefined; } | undefined"]},{"id":"def-common.AggParamsCumulativeSum.metricAgg","type":"string","label":"metricAgg","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/cumulative_sum.ts#L20"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/data/common/search/aggs/metrics/cumulative_sum.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/cumulative_sum.ts#L17"},"initialIsOpen":false},{"id":"def-common.AggParamsDerivative","type":"Interface","label":"AggParamsDerivative","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsDerivative","text":"AggParamsDerivative"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}],"description":[],"children":[{"id":"def-common.AggParamsDerivative.buckets_path","type":"string","label":"buckets_path","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/derivative.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/derivative.ts#L18"},"signature":["string | undefined"]},{"id":"def-common.AggParamsDerivative.customMetric","type":"Object","label":"customMetric","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/derivative.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/derivative.ts#L19"},"signature":["{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined; schema?: string | undefined; } | undefined"]},{"id":"def-common.AggParamsDerivative.metricAgg","type":"string","label":"metricAgg","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/derivative.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/derivative.ts#L20"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/data/common/search/aggs/metrics/derivative.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/derivative.ts#L17"},"initialIsOpen":false},{"id":"def-common.AggParamsGeoBounds","type":"Interface","label":"AggParamsGeoBounds","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsGeoBounds","text":"AggParamsGeoBounds"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}],"description":[],"children":[{"id":"def-common.AggParamsGeoBounds.field","type":"string","label":"field","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/geo_bounds.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/geo_bounds.ts#L17"}}],"source":{"path":"src/plugins/data/common/search/aggs/metrics/geo_bounds.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/geo_bounds.ts#L16"},"initialIsOpen":false},{"id":"def-common.AggParamsGeoCentroid","type":"Interface","label":"AggParamsGeoCentroid","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsGeoCentroid","text":"AggParamsGeoCentroid"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}],"description":[],"children":[{"id":"def-common.AggParamsGeoCentroid.field","type":"string","label":"field","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/geo_centroid.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/geo_centroid.ts#L17"}}],"source":{"path":"src/plugins/data/common/search/aggs/metrics/geo_centroid.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/geo_centroid.ts#L16"},"initialIsOpen":false},{"id":"def-common.AggParamsMax","type":"Interface","label":"AggParamsMax","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsMax","text":"AggParamsMax"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}],"description":[],"children":[{"id":"def-common.AggParamsMax.field","type":"string","label":"field","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/max.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/max.ts#L21"}}],"source":{"path":"src/plugins/data/common/search/aggs/metrics/max.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/max.ts#L20"},"initialIsOpen":false},{"id":"def-common.AggParamsMedian","type":"Interface","label":"AggParamsMedian","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsMedian","text":"AggParamsMedian"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}],"description":[],"children":[{"id":"def-common.AggParamsMedian.field","type":"string","label":"field","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/median.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/median.ts#L21"}}],"source":{"path":"src/plugins/data/common/search/aggs/metrics/median.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/median.ts#L20"},"initialIsOpen":false},{"id":"def-common.IMetricAggConfig","type":"Interface","label":"IMetricAggConfig","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IMetricAggConfig","text":"IMetricAggConfig"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"}],"description":[],"children":[{"id":"def-common.IMetricAggConfig.type","type":"Object","label":"type","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L17"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggType","text":"MetricAggType"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},">"]}],"source":{"path":"src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L16"},"initialIsOpen":false},{"id":"def-common.MetricAggParam","type":"Interface","label":"MetricAggParam","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggParam","text":"MetricAggParam"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamType","text":"AggParamType"},""],"description":[],"children":[{"id":"def-common.MetricAggParam.filterFieldTypes","type":"CompoundType","label":"filterFieldTypes","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L22"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"}," | \"*\" | ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"},"[] | undefined"]},{"id":"def-common.MetricAggParam.onlyAggregatable","type":"CompoundType","label":"onlyAggregatable","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L23"},"signature":["boolean | undefined"]}],"source":{"path":"src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L20"},"initialIsOpen":false},{"id":"def-common.AggParamsMin","type":"Interface","label":"AggParamsMin","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsMin","text":"AggParamsMin"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}],"description":[],"children":[{"id":"def-common.AggParamsMin.field","type":"string","label":"field","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/min.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/min.ts#L21"}}],"source":{"path":"src/plugins/data/common/search/aggs/metrics/min.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/min.ts#L20"},"initialIsOpen":false},{"id":"def-common.AggParamsMovingAvg","type":"Interface","label":"AggParamsMovingAvg","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsMovingAvg","text":"AggParamsMovingAvg"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}],"description":[],"children":[{"id":"def-common.AggParamsMovingAvg.buckets_path","type":"string","label":"buckets_path","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/moving_avg.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/moving_avg.ts#L18"},"signature":["string | undefined"]},{"id":"def-common.AggParamsMovingAvg.window","type":"number","label":"window","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/moving_avg.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/moving_avg.ts#L19"},"signature":["number | undefined"]},{"id":"def-common.AggParamsMovingAvg.script","type":"string","label":"script","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/moving_avg.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/moving_avg.ts#L20"},"signature":["string | undefined"]},{"id":"def-common.AggParamsMovingAvg.customMetric","type":"Object","label":"customMetric","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/moving_avg.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/moving_avg.ts#L21"},"signature":["{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined; schema?: string | undefined; } | undefined"]},{"id":"def-common.AggParamsMovingAvg.metricAgg","type":"string","label":"metricAgg","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/moving_avg.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/moving_avg.ts#L22"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/data/common/search/aggs/metrics/moving_avg.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/moving_avg.ts#L17"},"initialIsOpen":false},{"id":"def-common.AggParamsPercentileRanks","type":"Interface","label":"AggParamsPercentileRanks","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsPercentileRanks","text":"AggParamsPercentileRanks"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}],"description":[],"children":[{"id":"def-common.AggParamsPercentileRanks.field","type":"string","label":"field","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentile_ranks.ts#L22"}},{"id":"def-common.AggParamsPercentileRanks.values","type":"Array","label":"values","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentile_ranks.ts#L23"},"signature":["number[] | undefined"]}],"source":{"path":"src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentile_ranks.ts#L21"},"initialIsOpen":false},{"id":"def-common.PercentileRanksMetricAggDependencies","type":"Interface","label":"PercentileRanksMetricAggDependencies","description":[],"children":[{"id":"def-common.PercentileRanksMetricAggDependencies.getFieldFormatsStart","type":"Function","label":"getFieldFormatsStart","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentile_ranks.ts#L30"},"signature":["() => Pick, \"deserialize\" | \"getDefaultInstance\">"]}],"source":{"path":"src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentile_ranks.ts#L29"},"initialIsOpen":false},{"id":"def-common.AggParamsPercentiles","type":"Interface","label":"AggParamsPercentiles","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsPercentiles","text":"AggParamsPercentiles"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}],"description":[],"children":[{"id":"def-common.AggParamsPercentiles.field","type":"string","label":"field","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/percentiles.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentiles.ts#L20"}},{"id":"def-common.AggParamsPercentiles.percents","type":"Array","label":"percents","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/percentiles.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentiles.ts#L21"},"signature":["number[] | undefined"]}],"source":{"path":"src/plugins/data/common/search/aggs/metrics/percentiles.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentiles.ts#L19"},"initialIsOpen":false},{"id":"def-common.AggParamsSerialDiff","type":"Interface","label":"AggParamsSerialDiff","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsSerialDiff","text":"AggParamsSerialDiff"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}],"description":[],"children":[{"id":"def-common.AggParamsSerialDiff.buckets_path","type":"string","label":"buckets_path","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/serial_diff.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/serial_diff.ts#L18"},"signature":["string | undefined"]},{"id":"def-common.AggParamsSerialDiff.customMetric","type":"Object","label":"customMetric","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/serial_diff.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/serial_diff.ts#L19"},"signature":["{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined; schema?: string | undefined; } | undefined"]},{"id":"def-common.AggParamsSerialDiff.metricAgg","type":"string","label":"metricAgg","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/serial_diff.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/serial_diff.ts#L20"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/data/common/search/aggs/metrics/serial_diff.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/serial_diff.ts#L17"},"initialIsOpen":false},{"id":"def-common.AggParamsStdDeviation","type":"Interface","label":"AggParamsStdDeviation","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsStdDeviation","text":"AggParamsStdDeviation"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}],"description":[],"children":[{"id":"def-common.AggParamsStdDeviation.field","type":"string","label":"field","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/std_deviation.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/std_deviation.ts#L19"}}],"source":{"path":"src/plugins/data/common/search/aggs/metrics/std_deviation.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/std_deviation.ts#L18"},"initialIsOpen":false},{"id":"def-common.IStdDevAggConfig","type":"Interface","label":"IStdDevAggConfig","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IStdDevAggConfig","text":"IStdDevAggConfig"}," extends ","IResponseAggConfig"],"description":[],"children":[{"id":"def-common.IStdDevAggConfig.keyedDetails","type":"Function","label":"keyedDetails","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/std_deviation.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/std_deviation.ts#L28"},"signature":["(customLabel: string, fieldDisplayName?: string | undefined) => Record"]},{"id":"def-common.IStdDevAggConfig.valProp","type":"Function","label":"valProp","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/std_deviation.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/std_deviation.ts#L29"},"signature":["() => string[]"]}],"source":{"path":"src/plugins/data/common/search/aggs/metrics/std_deviation.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/std_deviation.ts#L27"},"initialIsOpen":false},{"id":"def-common.AggParamsSum","type":"Interface","label":"AggParamsSum","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsSum","text":"AggParamsSum"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}],"description":[],"children":[{"id":"def-common.AggParamsSum.field","type":"string","label":"field","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/sum.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/sum.ts#L21"}}],"source":{"path":"src/plugins/data/common/search/aggs/metrics/sum.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/sum.ts#L20"},"initialIsOpen":false},{"id":"def-common.AggParamsTopHit","type":"Interface","label":"AggParamsTopHit","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsTopHit","text":"AggParamsTopHit"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}],"description":[],"children":[{"id":"def-common.AggParamsTopHit.field","type":"string","label":"field","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/top_hit.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/top_hit.ts#L18"}},{"id":"def-common.AggParamsTopHit.aggregate","type":"CompoundType","label":"aggregate","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/top_hit.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/top_hit.ts#L19"},"signature":["\"max\" | \"min\" | \"concat\" | \"sum\" | \"average\""]},{"id":"def-common.AggParamsTopHit.sortField","type":"string","label":"sortField","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/top_hit.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/top_hit.ts#L20"},"signature":["string | undefined"]},{"id":"def-common.AggParamsTopHit.size","type":"number","label":"size","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/top_hit.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/top_hit.ts#L21"},"signature":["number | undefined"]},{"id":"def-common.AggParamsTopHit.sortOrder","type":"CompoundType","label":"sortOrder","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/top_hit.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/top_hit.ts#L22"},"signature":["\"asc\" | \"desc\" | undefined"]}],"source":{"path":"src/plugins/data/common/search/aggs/metrics/top_hit.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/top_hit.ts#L17"},"initialIsOpen":false},{"id":"def-common.OptionedValueProp","type":"Interface","label":"OptionedValueProp","description":[],"children":[{"id":"def-common.OptionedValueProp.value","type":"string","label":"value","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/optioned.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L13"}},{"id":"def-common.OptionedValueProp.text","type":"string","label":"text","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/optioned.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L14"}},{"id":"def-common.OptionedValueProp.disabled","type":"CompoundType","label":"disabled","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/optioned.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L15"},"signature":["boolean | undefined"]},{"id":"def-common.OptionedValueProp.isCompatible","type":"Function","label":"isCompatible","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/optioned.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L16"},"signature":["(agg: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},") => boolean"]}],"source":{"path":"src/plugins/data/common/search/aggs/param_types/optioned.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/optioned.ts#L12"},"initialIsOpen":false},{"id":"def-common.AggParamOption","type":"Interface","label":"AggParamOption","description":[],"children":[{"id":"def-common.AggParamOption.val","type":"string","label":"val","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_params.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L31"}},{"id":"def-common.AggParamOption.display","type":"string","label":"display","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_params.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L32"}},{"id":"def-common.AggParamOption.enabled","type":"Function","label":"enabled","signature":["((agg: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"},") => boolean) | undefined"],"description":[],"children":[{"type":"Object","label":"agg","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"}],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_params.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L33"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_params.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L33"}}],"source":{"path":"src/plugins/data/common/search/aggs/agg_params.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L30"},"initialIsOpen":false},{"id":"def-common.AggsCommonSetup","type":"Interface","label":"AggsCommonSetup","description":[],"children":[{"id":"def-common.AggsCommonSetup.types","type":"Object","label":"types","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L101"},"signature":["{ registerBucket: (name: N, type: T) => void; registerMetric: (name: N, type: T) => void; }"]}],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":100,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L100"},"initialIsOpen":false},{"id":"def-common.AggsCommonStart","type":"Interface","label":"AggsCommonStart","description":[],"children":[{"id":"def-common.AggsCommonStart.calculateAutoTimeExpression","type":"Function","label":"calculateAutoTimeExpression","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":106,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L106"},"signature":["(range: ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"},") => string | undefined"]},{"id":"def-common.AggsCommonStart.getDateMetaByDatatableColumn","type":"Function","label":"getDateMetaByDatatableColumn","description":["\nHelper function returning meta data about use date intervals for a data table column.\nIf the column is not a column created by a date histogram aggregation of the esaggs data source,\nthis function will return undefined.\n\nOtherwise, it will return the following attributes in an object:\n* `timeZone` time zone used to create the buckets (important e.g. for DST),\n* `timeRange` total time range of the fetch data (to infer partial buckets at the beginning and end of the data)\n* `interval` Interval used on elasticsearch (`auto` resolved to the actual interval)"],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":117,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L117"},"signature":["(column: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.DatatableColumn","text":"DatatableColumn"},") => Promise<{ timeZone: string; timeRange?: ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"}," | undefined; interval: string; } | undefined>"]},{"id":"def-common.AggsCommonStart.datatableUtilities","type":"Object","label":"datatableUtilities","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":120,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L120"},"signature":["{ getIndexPattern: (column: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.DatatableColumn","text":"DatatableColumn"},") => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}," | undefined>; getAggConfig: (column: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.DatatableColumn","text":"DatatableColumn"},") => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfig","text":"AggConfig"}," | undefined>; isFilterable: (column: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.DatatableColumn","text":"DatatableColumn"}]},{"id":"def-common.AggsCommonStart.createAggConfigs","type":"Function","label":"createAggConfigs","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":125,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L125"},"signature":["(indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},", configStates?: Pick & Pick<{ type: string | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IAggType","text":"IAggType"},"; }, \"type\"> & Pick<{ type: string | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IAggType","text":"IAggType"},"; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[] | undefined) => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggConfigs","text":"AggConfigs"}]},{"id":"def-common.AggsCommonStart.types","type":"Object","label":"types","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":129,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L129"},"signature":["{ get: (name: string) => any; getAll: () => { buckets: any[]; metrics: any[]; }; }"]}],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":105,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L105"},"initialIsOpen":false},{"id":"def-common.BaseAggParams","type":"Interface","label":"BaseAggParams","description":[],"children":[{"id":"def-common.BaseAggParams.json","type":"string","label":"json","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":143,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L143"},"signature":["string | undefined"]},{"id":"def-common.BaseAggParams.customLabel","type":"string","label":"customLabel","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":144,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L144"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":142,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L142"},"initialIsOpen":false},{"id":"def-common.AggExpressionType","type":"Interface","label":"AggExpressionType","description":[],"children":[{"id":"def-common.AggExpressionType.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":149,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L149"},"signature":["\"agg_type\""]},{"id":"def-common.AggExpressionType.value","type":"Object","label":"value","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":150,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L150"},"signature":["{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined; schema?: string | undefined; }"]}],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":148,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L148"},"initialIsOpen":false},{"id":"def-common.AggParamsMapping","type":"Interface","label":"AggParamsMapping","description":["\nA global list of the param interfaces for each agg type.\nFor now this is internal, but eventually we will probably\nwant to make it public.\n"],"children":[{"id":"def-common.AggParamsMapping.[BUCKET_TYPES.RANGE]","type":"Object","label":"[BUCKET_TYPES.RANGE]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":166,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L166"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsRange","text":"AggParamsRange"}]},{"id":"def-common.AggParamsMapping.[BUCKET_TYPES.IP_RANGE]","type":"Object","label":"[BUCKET_TYPES.IP_RANGE]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":167,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L167"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsIpRange","text":"AggParamsIpRange"}]},{"id":"def-common.AggParamsMapping.[BUCKET_TYPES.DATE_RANGE]","type":"Object","label":"[BUCKET_TYPES.DATE_RANGE]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":168,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L168"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsDateRange","text":"AggParamsDateRange"}]},{"id":"def-common.AggParamsMapping.[BUCKET_TYPES.FILTER]","type":"Object","label":"[BUCKET_TYPES.FILTER]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":169,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L169"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsFilter","text":"AggParamsFilter"}]},{"id":"def-common.AggParamsMapping.[BUCKET_TYPES.FILTERS]","type":"Object","label":"[BUCKET_TYPES.FILTERS]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":170,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L170"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsFilters","text":"AggParamsFilters"}]},{"id":"def-common.AggParamsMapping.[BUCKET_TYPES.SIGNIFICANT_TERMS]","type":"Object","label":"[BUCKET_TYPES.SIGNIFICANT_TERMS]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":171,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L171"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsSignificantTerms","text":"AggParamsSignificantTerms"}]},{"id":"def-common.AggParamsMapping.[BUCKET_TYPES.GEOTILE_GRID]","type":"Object","label":"[BUCKET_TYPES.GEOTILE_GRID]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":172,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L172"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsGeoTile","text":"AggParamsGeoTile"}]},{"id":"def-common.AggParamsMapping.[BUCKET_TYPES.GEOHASH_GRID]","type":"Object","label":"[BUCKET_TYPES.GEOHASH_GRID]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":173,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L173"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsGeoHash","text":"AggParamsGeoHash"}]},{"id":"def-common.AggParamsMapping.[BUCKET_TYPES.HISTOGRAM]","type":"Object","label":"[BUCKET_TYPES.HISTOGRAM]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":174,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L174"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsHistogram","text":"AggParamsHistogram"}]},{"id":"def-common.AggParamsMapping.[BUCKET_TYPES.DATE_HISTOGRAM]","type":"Object","label":"[BUCKET_TYPES.DATE_HISTOGRAM]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":175,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L175"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsDateHistogram","text":"AggParamsDateHistogram"}]},{"id":"def-common.AggParamsMapping.[BUCKET_TYPES.TERMS]","type":"Object","label":"[BUCKET_TYPES.TERMS]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":176,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L176"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsTerms","text":"AggParamsTerms"}]},{"id":"def-common.AggParamsMapping.[METRIC_TYPES.AVG]","type":"Object","label":"[METRIC_TYPES.AVG]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":177,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L177"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsAvg","text":"AggParamsAvg"}]},{"id":"def-common.AggParamsMapping.[METRIC_TYPES.CARDINALITY]","type":"Object","label":"[METRIC_TYPES.CARDINALITY]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":178,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L178"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsCardinality","text":"AggParamsCardinality"}]},{"id":"def-common.AggParamsMapping.[METRIC_TYPES.COUNT]","type":"Object","label":"[METRIC_TYPES.COUNT]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":179,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L179"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BaseAggParams","text":"BaseAggParams"}]},{"id":"def-common.AggParamsMapping.[METRIC_TYPES.GEO_BOUNDS]","type":"Object","label":"[METRIC_TYPES.GEO_BOUNDS]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":180,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L180"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsGeoBounds","text":"AggParamsGeoBounds"}]},{"id":"def-common.AggParamsMapping.[METRIC_TYPES.GEO_CENTROID]","type":"Object","label":"[METRIC_TYPES.GEO_CENTROID]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":181,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L181"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsGeoCentroid","text":"AggParamsGeoCentroid"}]},{"id":"def-common.AggParamsMapping.[METRIC_TYPES.MAX]","type":"Object","label":"[METRIC_TYPES.MAX]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":182,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L182"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsMax","text":"AggParamsMax"}]},{"id":"def-common.AggParamsMapping.[METRIC_TYPES.MEDIAN]","type":"Object","label":"[METRIC_TYPES.MEDIAN]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":183,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L183"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsMedian","text":"AggParamsMedian"}]},{"id":"def-common.AggParamsMapping.[METRIC_TYPES.MIN]","type":"Object","label":"[METRIC_TYPES.MIN]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":184,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L184"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsMin","text":"AggParamsMin"}]},{"id":"def-common.AggParamsMapping.[METRIC_TYPES.STD_DEV]","type":"Object","label":"[METRIC_TYPES.STD_DEV]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":185,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L185"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsStdDeviation","text":"AggParamsStdDeviation"}]},{"id":"def-common.AggParamsMapping.[METRIC_TYPES.SUM]","type":"Object","label":"[METRIC_TYPES.SUM]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":186,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L186"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsSum","text":"AggParamsSum"}]},{"id":"def-common.AggParamsMapping.[METRIC_TYPES.AVG_BUCKET]","type":"Object","label":"[METRIC_TYPES.AVG_BUCKET]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":187,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L187"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsBucketAvg","text":"AggParamsBucketAvg"}]},{"id":"def-common.AggParamsMapping.[METRIC_TYPES.MAX_BUCKET]","type":"Object","label":"[METRIC_TYPES.MAX_BUCKET]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":188,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L188"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsBucketMax","text":"AggParamsBucketMax"}]},{"id":"def-common.AggParamsMapping.[METRIC_TYPES.MIN_BUCKET]","type":"Object","label":"[METRIC_TYPES.MIN_BUCKET]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":189,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L189"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsBucketMin","text":"AggParamsBucketMin"}]},{"id":"def-common.AggParamsMapping.[METRIC_TYPES.SUM_BUCKET]","type":"Object","label":"[METRIC_TYPES.SUM_BUCKET]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":190,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L190"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsBucketSum","text":"AggParamsBucketSum"}]},{"id":"def-common.AggParamsMapping.[METRIC_TYPES.CUMULATIVE_SUM]","type":"Object","label":"[METRIC_TYPES.CUMULATIVE_SUM]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":191,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L191"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsCumulativeSum","text":"AggParamsCumulativeSum"}]},{"id":"def-common.AggParamsMapping.[METRIC_TYPES.DERIVATIVE]","type":"Object","label":"[METRIC_TYPES.DERIVATIVE]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":192,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L192"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsDerivative","text":"AggParamsDerivative"}]},{"id":"def-common.AggParamsMapping.[METRIC_TYPES.MOVING_FN]","type":"Object","label":"[METRIC_TYPES.MOVING_FN]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":193,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L193"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsMovingAvg","text":"AggParamsMovingAvg"}]},{"id":"def-common.AggParamsMapping.[METRIC_TYPES.PERCENTILE_RANKS]","type":"Object","label":"[METRIC_TYPES.PERCENTILE_RANKS]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":194,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L194"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsPercentileRanks","text":"AggParamsPercentileRanks"}]},{"id":"def-common.AggParamsMapping.[METRIC_TYPES.PERCENTILES]","type":"Object","label":"[METRIC_TYPES.PERCENTILES]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":195,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L195"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsPercentiles","text":"AggParamsPercentiles"}]},{"id":"def-common.AggParamsMapping.[METRIC_TYPES.SERIAL_DIFF]","type":"Object","label":"[METRIC_TYPES.SERIAL_DIFF]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":196,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L196"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsSerialDiff","text":"AggParamsSerialDiff"}]},{"id":"def-common.AggParamsMapping.[METRIC_TYPES.TOP_HITS]","type":"Object","label":"[METRIC_TYPES.TOP_HITS]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":197,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L197"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggParamsTopHit","text":"AggParamsTopHit"}]}],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":165,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L165"},"initialIsOpen":false},{"id":"def-common.AggFunctionsMapping","type":"Interface","label":"AggFunctionsMapping","description":["\nA global list of the expression function definitions for each agg type function."],"children":[{"id":"def-common.AggFunctionsMapping.aggFilter","type":"Object","label":"aggFilter","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":204,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L204"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggFilters","type":"Object","label":"aggFilters","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":205,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L205"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggSignificantTerms","type":"Object","label":"aggSignificantTerms","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":206,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L206"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggIpRange","type":"Object","label":"aggIpRange","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":207,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L207"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggDateRange","type":"Object","label":"aggDateRange","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":208,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L208"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggRange","type":"Object","label":"aggRange","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":209,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L209"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggGeoTile","type":"Object","label":"aggGeoTile","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":210,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L210"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggGeoHash","type":"Object","label":"aggGeoHash","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":211,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L211"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggHistogram","type":"Object","label":"aggHistogram","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":212,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L212"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggDateHistogram","type":"Object","label":"aggDateHistogram","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":213,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L213"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggTerms","type":"Object","label":"aggTerms","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":214,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L214"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggAvg","type":"Object","label":"aggAvg","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":215,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L215"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggBucketAvg","type":"Object","label":"aggBucketAvg","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":216,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L216"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggBucketMax","type":"Object","label":"aggBucketMax","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":217,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L217"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggBucketMin","type":"Object","label":"aggBucketMin","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":218,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L218"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggBucketSum","type":"Object","label":"aggBucketSum","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":219,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L219"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggCardinality","type":"Object","label":"aggCardinality","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":220,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L220"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggCount","type":"Object","label":"aggCount","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":221,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L221"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggCumulativeSum","type":"Object","label":"aggCumulativeSum","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":222,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L222"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggDerivative","type":"Object","label":"aggDerivative","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":223,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L223"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggGeoBounds","type":"Object","label":"aggGeoBounds","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":224,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L224"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggGeoCentroid","type":"Object","label":"aggGeoCentroid","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":225,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L225"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggMax","type":"Object","label":"aggMax","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":226,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L226"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggMedian","type":"Object","label":"aggMedian","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":227,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L227"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggMin","type":"Object","label":"aggMin","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":228,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L228"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggMovingAvg","type":"Object","label":"aggMovingAvg","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":229,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L229"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggPercentileRanks","type":"Object","label":"aggPercentileRanks","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":230,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L230"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggPercentiles","type":"Object","label":"aggPercentiles","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":231,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L231"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggSerialDiff","type":"Object","label":"aggSerialDiff","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":232,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L232"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggStdDeviation","type":"Object","label":"aggStdDeviation","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":233,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L233"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggSum","type":"Object","label":"aggSum","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":234,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L234"},"signature":["FunctionDefinition"]},{"id":"def-common.AggFunctionsMapping.aggTopHit","type":"Object","label":"aggTopHit","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":235,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L235"},"signature":["FunctionDefinition"]}],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":203,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L203"},"initialIsOpen":false},{"id":"def-common.IEsSearchRequest","type":"Interface","label":"IEsSearchRequest","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IEsSearchRequest","text":"IEsSearchRequest"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IKibanaSearchRequest","text":"IKibanaSearchRequest"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchRequestParams","text":"ISearchRequestParams"},">>"],"description":[],"children":[{"id":"def-common.IEsSearchRequest.indexType","type":"string","label":"indexType","description":[],"source":{"path":"src/plugins/data/common/search/es_search/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/es_search/types.ts#L20"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/data/common/search/es_search/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/es_search/types.ts#L19"},"initialIsOpen":false},{"id":"def-common.EsaggsStartDependencies","type":"Interface","label":"EsaggsStartDependencies","description":[],"children":[{"id":"def-common.EsaggsStartDependencies.aggs","type":"Object","label":"aggs","description":[],"source":{"path":"src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#L44"},"signature":["Pick & Pick<{ types: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggTypesRegistryStart","text":"AggTypesRegistryStart"},"; }, \"types\"> & Pick<{ types: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.AggTypesRegistryStart","text":"AggTypesRegistryStart"},"; }, never>, \"calculateAutoTimeExpression\" | \"getDateMetaByDatatableColumn\" | \"datatableUtilities\" | \"createAggConfigs\" | \"types\">"]},{"id":"def-common.EsaggsStartDependencies.indexPatterns","type":"Object","label":"indexPatterns","description":[],"source":{"path":"src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#L45"},"signature":["Pick<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternsService","text":"IndexPatternsService"},", \"get\" | \"delete\" | \"create\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"find\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">"]},{"id":"def-common.EsaggsStartDependencies.searchSource","type":"Object","label":"searchSource","description":[],"source":{"path":"src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#L46"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchStartSearchSource","text":"ISearchStartSearchSource"}]},{"id":"def-common.EsaggsStartDependencies.getNow","type":"Function","label":"getNow","description":[],"source":{"path":"src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#L47"},"signature":["(() => Date) | undefined"]}],"source":{"path":"src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#L43"},"initialIsOpen":false},{"id":"def-common.FetchHandlers","type":"Interface","label":"FetchHandlers","description":[],"children":[{"id":"def-common.FetchHandlers.getConfig","type":"Function","label":"getConfig","description":[],"source":{"path":"src/plugins/data/common/search/search_source/fetch/types.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L23"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.GetConfigFn","text":"GetConfigFn"}]},{"id":"def-common.FetchHandlers.onResponse","type":"Function","label":"onResponse","description":["\nCallback which can be used to hook into responses, modify them, or perform\nside effects like displaying UI errors on the client."],"source":{"path":"src/plugins/data/common/search/search_source/fetch/types.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L28"},"signature":["(request: Record, response: ","SearchResponse",") => ","SearchResponse",""]},{"id":"def-common.FetchHandlers.legacy","type":"Object","label":"legacy","description":["\nThese handlers are only used by the legacy defaultSearchStrategy and can be removed\nonce that strategy has been deprecated."],"source":{"path":"src/plugins/data/common/search/search_source/fetch/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L33"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.LegacyFetchHandlers","text":"LegacyFetchHandlers"}]}],"source":{"path":"src/plugins/data/common/search/search_source/fetch/types.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L22"},"initialIsOpen":false},{"id":"def-common.SearchError","type":"Interface","label":"SearchError","description":[],"children":[{"id":"def-common.SearchError.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/data/common/search/search_source/fetch/types.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L37"}},{"id":"def-common.SearchError.status","type":"string","label":"status","description":[],"source":{"path":"src/plugins/data/common/search/search_source/fetch/types.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L38"}},{"id":"def-common.SearchError.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/data/common/search/search_source/fetch/types.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L39"}},{"id":"def-common.SearchError.message","type":"string","label":"message","description":[],"source":{"path":"src/plugins/data/common/search/search_source/fetch/types.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L40"}},{"id":"def-common.SearchError.path","type":"string","label":"path","description":[],"source":{"path":"src/plugins/data/common/search/search_source/fetch/types.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L41"}},{"id":"def-common.SearchError.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/common/search/search_source/fetch/types.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L42"}}],"source":{"path":"src/plugins/data/common/search/search_source/fetch/types.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L36"},"initialIsOpen":false},{"id":"def-common.MsearchRequestBody","type":"Interface","label":"MsearchRequestBody","description":[],"children":[{"id":"def-common.MsearchRequestBody.searches","type":"Array","label":"searches","description":[],"source":{"path":"src/plugins/data/common/search/search_source/legacy/types.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/types.ts#L26"},"signature":["MsearchRequest[]"]}],"source":{"path":"src/plugins/data/common/search/search_source/legacy/types.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/types.ts#L25"},"initialIsOpen":false},{"id":"def-common.MsearchResponse","type":"Interface","label":"MsearchResponse","description":[],"children":[{"id":"def-common.MsearchResponse.body","type":"Object","label":"body","description":[],"source":{"path":"src/plugins/data/common/search/search_source/legacy/types.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/types.ts#L31"},"signature":["ApiResponse","<{ responses: ","SearchResponse","[]; }, ","Context",">"]}],"source":{"path":"src/plugins/data/common/search/search_source/legacy/types.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/types.ts#L30"},"initialIsOpen":false},{"id":"def-common.LegacyFetchHandlers","type":"Interface","label":"LegacyFetchHandlers","description":[],"children":[{"id":"def-common.LegacyFetchHandlers.callMsearch","type":"Function","label":"callMsearch","description":[],"source":{"path":"src/plugins/data/common/search/search_source/legacy/types.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/types.ts#L36"},"signature":["(params: { body: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MsearchRequestBody","text":"MsearchRequestBody"},"; signal: AbortSignal; }) => Promise<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MsearchResponse","text":"MsearchResponse"},">"]},{"id":"def-common.LegacyFetchHandlers.loadingCount$","type":"Object","label":"loadingCount$","description":[],"source":{"path":"src/plugins/data/common/search/search_source/legacy/types.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/types.ts#L40"},"signature":["BehaviorSubject",""]}],"source":{"path":"src/plugins/data/common/search/search_source/legacy/types.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/types.ts#L35"},"initialIsOpen":false},{"id":"def-common.SearchStrategySearchParams","type":"Interface","label":"SearchStrategySearchParams","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchStrategySearchParams","text":"SearchStrategySearchParams"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.FetchHandlers","text":"FetchHandlers"}],"description":[],"children":[{"id":"def-common.SearchStrategySearchParams.searchRequests","type":"Array","label":"searchRequests","description":[],"source":{"path":"src/plugins/data/common/search/search_source/legacy/types.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/types.ts#L44"},"signature":["Record[]"]}],"source":{"path":"src/plugins/data/common/search/search_source/legacy/types.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/types.ts#L43"},"initialIsOpen":false},{"id":"def-common.SearchStrategyProvider","type":"Interface","label":"SearchStrategyProvider","description":[],"children":[{"id":"def-common.SearchStrategyProvider.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/data/common/search/search_source/legacy/types.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/types.ts#L49"}},{"id":"def-common.SearchStrategyProvider.search","type":"Function","label":"search","description":[],"source":{"path":"src/plugins/data/common/search/search_source/legacy/types.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/types.ts#L50"},"signature":["(params: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchStrategySearchParams","text":"SearchStrategySearchParams"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchStrategyResponse","text":"SearchStrategyResponse"},""]}],"source":{"path":"src/plugins/data/common/search/search_source/legacy/types.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/types.ts#L48"},"initialIsOpen":false},{"id":"def-common.SearchStrategyResponse","type":"Interface","label":"SearchStrategyResponse","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchStrategyResponse","text":"SearchStrategyResponse"},""],"description":[],"children":[{"id":"def-common.SearchStrategyResponse.searching","type":"Object","label":"searching","description":[],"source":{"path":"src/plugins/data/common/search/search_source/legacy/types.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/types.ts#L54"},"signature":["Promise<","SearchResponse","[]>"]},{"id":"def-common.SearchStrategyResponse.abort","type":"Function","label":"abort","description":[],"source":{"path":"src/plugins/data/common/search/search_source/legacy/types.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/types.ts#L55"},"signature":["() => void"]}],"source":{"path":"src/plugins/data/common/search/search_source/legacy/types.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/legacy/types.ts#L53"},"initialIsOpen":false},{"id":"def-common.SearchSourceDependencies","type":"Interface","label":"SearchSourceDependencies","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceDependencies","text":"SearchSourceDependencies"}," extends ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.FetchHandlers","text":"FetchHandlers"}],"description":[],"children":[{"id":"def-common.SearchSourceDependencies.search","type":"Function","label":"search","description":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":100,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L100"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchGeneric","text":"ISearchGeneric"}]}],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L99"},"initialIsOpen":false},{"id":"def-common.ISearchStartSearchSource","type":"Interface","label":"ISearchStartSearchSource","description":["\nhigh level search service"],"children":[{"id":"def-common.ISearchStartSearchSource.create","type":"Function","label":"create","description":["\ncreates {@link SearchSource} based on provided serialized {@link SearchSourceFields}"],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L30"},"signature":["(fields?: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"}," | undefined) => Promise>"]},{"id":"def-common.ISearchStartSearchSource.createEmpty","type":"Function","label":"createEmpty","description":["\ncreates empty {@link SearchSource}"],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L34"},"signature":["() => Pick<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"},", \"create\" | \"history\" | \"setPreferredSearchStrategyId\" | \"setField\" | \"removeField\" | \"setFields\" | \"getId\" | \"getFields\" | \"getField\" | \"getOwnField\" | \"createCopy\" | \"createChild\" | \"setParent\" | \"getParent\" | \"fetch$\" | \"fetch\" | \"onRequestStart\" | \"getSearchRequestBody\" | \"destroy\" | \"getSerializedFields\" | \"serialize\">"]}],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L25"},"initialIsOpen":false},{"id":"def-common.SortDirectionNumeric","type":"Interface","label":"SortDirectionNumeric","description":[],"children":[{"id":"def-common.SortDirectionNumeric.order","type":"Enum","label":"order","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L45"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SortDirection","text":"SortDirection"}]},{"id":"def-common.SortDirectionNumeric.numeric_type","type":"CompoundType","label":"numeric_type","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L46"},"signature":["\"date\" | \"long\" | \"double\" | \"date_nanos\" | undefined"]}],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L44"},"initialIsOpen":false},{"id":"def-common.SearchSourceFields","type":"Interface","label":"SearchSourceFields","description":["\nsearch source fields"],"children":[{"id":"def-common.SearchSourceFields.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L62"},"signature":["string | undefined"]},{"id":"def-common.SearchSourceFields.query","type":"Object","label":"query","description":["\n{@link Query}"],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L66"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.Query","text":"Query"}," | undefined"]},{"id":"def-common.SearchSourceFields.filter","type":"CompoundType","label":"filter","description":["\n{@link Filter}"],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L70"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[] | (() => ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[] | undefined) | undefined"]},{"id":"def-common.SearchSourceFields.sort","type":"CompoundType","label":"sort","description":["\n{@link EsQuerySortValue}"],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L74"},"signature":["Record | Record[] | undefined"]},{"id":"def-common.SearchSourceFields.highlight","type":"Any","label":"highlight","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L75"},"signature":["any"]},{"id":"def-common.SearchSourceFields.highlightAll","type":"CompoundType","label":"highlightAll","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":76,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L76"},"signature":["boolean | undefined"]},{"id":"def-common.SearchSourceFields.trackTotalHits","type":"CompoundType","label":"trackTotalHits","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L77"},"signature":["number | boolean | undefined"]},{"id":"def-common.SearchSourceFields.aggs","type":"Any","label":"aggs","description":["\n{@link AggConfigs}"],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L81"},"signature":["any"]},{"id":"def-common.SearchSourceFields.from","type":"number","label":"from","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L82"},"signature":["number | undefined"]},{"id":"def-common.SearchSourceFields.size","type":"number","label":"size","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L83"},"signature":["number | undefined"]},{"id":"def-common.SearchSourceFields.source","type":"CompoundType","label":"source","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L84"},"signature":["string | boolean | string[] | undefined"]},{"id":"def-common.SearchSourceFields.version","type":"CompoundType","label":"version","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":85,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L85"},"signature":["boolean | undefined"]},{"id":"def-common.SearchSourceFields.fields","type":"Array","label":"fields","description":["\nRetrieve fields via the search Fields API"],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L89"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchFieldValue","text":"SearchFieldValue"},"[] | undefined"]},{"id":"def-common.SearchSourceFields.fieldsFromSource","type":"CompoundType","label":"fieldsFromSource","description":["\nRetreive fields directly from _source (legacy behavior)\n"],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L95"},"signature":["string | boolean | string[] | undefined"]},{"id":"def-common.SearchSourceFields.index","type":"Object","label":"index","description":["\n{@link IndexPatternService}"],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L99"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}," | undefined"]},{"id":"def-common.SearchSourceFields.searchAfter","type":"Object","label":"searchAfter","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":100,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L100"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.EsQuerySearchAfter","text":"EsQuerySearchAfter"}," | undefined"]},{"id":"def-common.SearchSourceFields.timeout","type":"string","label":"timeout","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L101"},"signature":["string | undefined"]},{"id":"def-common.SearchSourceFields.terminate_after","type":"number","label":"terminate_after","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L102"},"signature":["number | undefined"]},{"id":"def-common.SearchSourceFields.parent","type":"Object","label":"parent","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L104"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSourceFields","text":"SearchSourceFields"}," | undefined"]}],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L61"},"initialIsOpen":false},{"id":"def-common.SearchSourceOptions","type":"Interface","label":"SearchSourceOptions","description":[],"children":[{"id":"def-common.SearchSourceOptions.callParentStartHandlers","type":"CompoundType","label":"callParentStartHandlers","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L108"},"signature":["boolean | undefined"]}],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":107,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L107"},"initialIsOpen":false},{"id":"def-common.SortOptions","type":"Interface","label":"SortOptions","description":[],"children":[{"id":"def-common.SortOptions.mode","type":"CompoundType","label":"mode","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":112,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L112"},"signature":["\"max\" | \"min\" | \"sum\" | \"avg\" | \"median\" | undefined"]},{"id":"def-common.SortOptions.type","type":"CompoundType","label":"type","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":113,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L113"},"signature":["\"date\" | \"long\" | \"double\" | \"date_nanos\" | undefined"]},{"id":"def-common.SortOptions.nested","type":"Uncategorized","label":"nested","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":114,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L114"},"signature":["object | undefined"]},{"id":"def-common.SortOptions.unmapped_type","type":"string","label":"unmapped_type","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L115"},"signature":["string | undefined"]},{"id":"def-common.SortOptions.distance_type","type":"CompoundType","label":"distance_type","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L116"},"signature":["\"arc\" | \"plane\" | undefined"]},{"id":"def-common.SortOptions.unit","type":"string","label":"unit","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":117,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L117"},"signature":["string | undefined"]},{"id":"def-common.SortOptions.ignore_unmapped","type":"CompoundType","label":"ignore_unmapped","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":118,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L118"},"signature":["boolean | undefined"]},{"id":"def-common.SortOptions._script","type":"Uncategorized","label":"_script","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":119,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L119"},"signature":["object | undefined"]}],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":111,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L111"},"initialIsOpen":false},{"id":"def-common.Request","type":"Interface","label":"Request","description":[],"children":[{"id":"def-common.Request.docvalue_fields","type":"Array","label":"docvalue_fields","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":123,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L123"},"signature":["string[]"]},{"id":"def-common.Request._source","type":"Unknown","label":"_source","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":124,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L124"},"signature":["unknown"]},{"id":"def-common.Request.query","type":"Unknown","label":"query","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":125,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L125"},"signature":["unknown"]},{"id":"def-common.Request.script_fields","type":"Unknown","label":"script_fields","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":126,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L126"},"signature":["unknown"]},{"id":"def-common.Request.sort","type":"Unknown","label":"sort","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":127,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L127"},"signature":["unknown"]},{"id":"def-common.Request.stored_fields","type":"Array","label":"stored_fields","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":128,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L128"},"signature":["string[]"]}],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":122,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L122"},"initialIsOpen":false},{"id":"def-common.ResponseWithShardFailure","type":"Interface","label":"ResponseWithShardFailure","description":[],"children":[{"id":"def-common.ResponseWithShardFailure._shards","type":"Object","label":"_shards","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":132,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L132"},"signature":["{ failed: number; failures: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ShardFailure","text":"ShardFailure"},"[]; skipped: number; successful: number; total: number; }"]}],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L131"},"initialIsOpen":false},{"id":"def-common.ShardFailure","type":"Interface","label":"ShardFailure","description":[],"children":[{"id":"def-common.ShardFailure.index","type":"string","label":"index","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":142,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L142"}},{"id":"def-common.ShardFailure.node","type":"string","label":"node","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":143,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L143"}},{"id":"def-common.ShardFailure.reason","type":"Object","label":"reason","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":144,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L144"},"signature":["{ caused_by: { reason: string; type: string; }; reason: string; lang?: string | undefined; script?: string | undefined; script_stack?: string[] | undefined; type: string; }"]},{"id":"def-common.ShardFailure.shard","type":"number","label":"shard","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":155,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L155"}}],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":141,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L141"},"initialIsOpen":false},{"id":"def-common.ISearchClient","type":"Interface","label":"ISearchClient","description":[],"children":[{"id":"def-common.ISearchClient.search","type":"Function","label":"search","description":[],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L29"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchGeneric","text":"ISearchGeneric"}]},{"id":"def-common.ISearchClient.cancel","type":"Function","label":"cancel","description":["\nUsed to cancel an in-progress search request."],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L33"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchCancelGeneric","text":"ISearchCancelGeneric"}]},{"id":"def-common.ISearchClient.extend","type":"Function","label":"extend","description":["\nUsed to extend the TTL of an in-progress search request."],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L37"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchExtendGeneric","text":"ISearchExtendGeneric"}]}],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L28"},"initialIsOpen":false},{"id":"def-common.IKibanaSearchResponse","type":"Interface","label":"IKibanaSearchResponse","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IKibanaSearchResponse","text":"IKibanaSearchResponse"},""],"description":[],"children":[{"id":"def-common.IKibanaSearchResponse.id","type":"string","label":"id","description":["\nSome responses may contain a unique id to identify the request this response came from."],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L44"},"signature":["string | undefined"]},{"id":"def-common.IKibanaSearchResponse.total","type":"number","label":"total","description":["\nIf relevant to the search strategy, return a total number\nthat represents how progress is indicated."],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L50"},"signature":["number | undefined"]},{"id":"def-common.IKibanaSearchResponse.loaded","type":"number","label":"loaded","description":["\nIf relevant to the search strategy, return a loaded number\nthat represents how progress is indicated."],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L56"},"signature":["number | undefined"]},{"id":"def-common.IKibanaSearchResponse.isRunning","type":"CompoundType","label":"isRunning","description":["\nIndicates whether search is still in flight"],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L61"},"signature":["boolean | undefined"]},{"id":"def-common.IKibanaSearchResponse.isPartial","type":"CompoundType","label":"isPartial","description":["\nIndicates whether the results returned are complete or partial"],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L66"},"signature":["boolean | undefined"]},{"id":"def-common.IKibanaSearchResponse.rawResponse","type":"Uncategorized","label":"rawResponse","description":["\nThe raw response returned by the internal search method (usually the raw ES response)"],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L71"},"signature":["RawResponse"]}],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L40"},"initialIsOpen":false},{"id":"def-common.IKibanaSearchRequest","type":"Interface","label":"IKibanaSearchRequest","signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IKibanaSearchRequest","text":"IKibanaSearchRequest"},""],"description":[],"children":[{"id":"def-common.IKibanaSearchRequest.id","type":"string","label":"id","description":["\nAn id can be used to uniquely identify this request."],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L78"},"signature":["string | undefined"]},{"id":"def-common.IKibanaSearchRequest.params","type":"Uncategorized","label":"params","description":[],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L80"},"signature":["Params | undefined"]}],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L74"},"initialIsOpen":false},{"id":"def-common.ISearchOptions","type":"Interface","label":"ISearchOptions","description":[],"children":[{"id":"def-common.ISearchOptions.abortSignal","type":"Object","label":"abortSignal","description":["\nAn `AbortSignal` that allows the caller of `search` to abort a search request."],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":87,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L87"},"signature":["AbortSignal | undefined"]},{"id":"def-common.ISearchOptions.strategy","type":"string","label":"strategy","description":["\nUse this option to force using a specific server side search strategy. Leave empty to use the default strategy."],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L92"},"signature":["string | undefined"]},{"id":"def-common.ISearchOptions.legacyHitsTotal","type":"CompoundType","label":"legacyHitsTotal","description":["\nRequest the legacy format for the total number of hits. If sending `rest_total_hits_as_int` to\nsomething other than `true`, this should be set to `false`."],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L98"},"signature":["boolean | undefined"]},{"id":"def-common.ISearchOptions.sessionId","type":"string","label":"sessionId","description":["\nA session ID, grouping multiple search requests into a single session."],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L103"},"signature":["string | undefined"]},{"id":"def-common.ISearchOptions.isStored","type":"CompoundType","label":"isStored","description":["\nWhether the session is already saved (i.e. sent to background)"],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L108"},"signature":["boolean | undefined"]},{"id":"def-common.ISearchOptions.isRestore","type":"CompoundType","label":"isRestore","description":["\nWhether the session is restored (i.e. search requests should re-use the stored search IDs,\nrather than starting from scratch)"],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":114,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L114"},"signature":["boolean | undefined"]},{"id":"def-common.ISearchOptions.indexPattern","type":"Object","label":"indexPattern","description":["\nIndex pattern reference is used for better error messages"],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":120,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L120"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}," | undefined"]}],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L83"},"initialIsOpen":false}],"enums":[{"id":"def-common.BUCKET_TYPES","type":"Enum","label":"BUCKET_TYPES","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/bucket_agg_types.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/bucket_agg_types.ts#L9"},"initialIsOpen":false},{"id":"def-common.IP_RANGE_TYPES","type":"Enum","label":"IP_RANGE_TYPES","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/ip_range.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/ip_range.ts#L24"},"initialIsOpen":false},{"id":"def-common.METRIC_TYPES","type":"Enum","label":"METRIC_TYPES","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/metric_agg_types.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_types.ts#L9"},"initialIsOpen":false},{"id":"def-common.SortDirection","type":"Enum","label":"SortDirection","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L39"},"initialIsOpen":false}],"misc":[{"id":"def-common.AggConfigSerialized","type":"Type","label":"AggConfigSerialized","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L32"},"signature":["{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | SerializableState | undefined; schema?: string | undefined; }"],"initialIsOpen":false},{"id":"def-common.AggConfigOptions","type":"Type","label":"AggConfigOptions","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L43"},"signature":["{ type: IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | SerializableState | undefined; }"],"initialIsOpen":false},{"id":"def-common.IAggConfig","type":"Type","label":"IAggConfig","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_config.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_config.ts#L53"},"signature":["AggConfig"],"initialIsOpen":false},{"id":"def-common.CreateAggConfigParams","type":"Type","label":"CreateAggConfigParams","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L41"},"signature":["{ type: string | IAggType; enabled?: boolean | undefined; id?: string | undefined; schema?: string | undefined; params?: {} | ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined; }"],"initialIsOpen":false},{"id":"def-common.IAggConfigs","type":"Type","label":"IAggConfigs","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_configs.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_configs.ts#L55"},"signature":["AggConfigs"],"initialIsOpen":false},{"id":"def-common.AggGroupName","type":"Type","label":"AggGroupName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_groups.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L18"},"signature":["\"buckets\" | \"metrics\" | \"none\""],"initialIsOpen":false},{"id":"def-common.IAggType","type":"Type","label":"IAggType","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_type.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_type.ts#L58"},"signature":["AggType>"],"initialIsOpen":false},{"id":"def-common.AggTypesRegistrySetup","type":"Type","label":"AggTypesRegistrySetup","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_types_registry.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_types_registry.ts#L13"},"signature":["{ registerBucket: (name: N, type: T) => void; registerMetric: (name: N, type: T) => void; }"],"initialIsOpen":false},{"id":"def-common.aggsRequiredUiSettings","type":"Array","label":"aggsRequiredUiSettings","description":[],"source":{"path":"src/plugins/data/common/search/aggs/aggs_service.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/aggs_service.ts#L24"},"signature":["string[]"],"initialIsOpen":false},{"id":"def-common.autoInterval","type":"string","label":"autoInterval","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/_interval_options.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/_interval_options.ts#L12"},"signature":["\"auto\""],"initialIsOpen":false},{"id":"def-common.intervalOptions","type":"Array","label":"intervalOptions","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/_interval_options.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/_interval_options.ts#L15"},"signature":["({ display: string; val: string; enabled(agg: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IBucketAggConfig","text":"IBucketAggConfig"},"): boolean | \"\" | undefined; } | { display: string; val: string; })[]"],"initialIsOpen":false},{"id":"def-common.aggDateHistogramFnName","type":"string","label":"aggDateHistogramFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_histogram_fn.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram_fn.ts#L15"},"signature":["\"aggDateHistogram\""],"initialIsOpen":false},{"id":"def-common.CalculateBoundsFn","type":"Type","label":"CalculateBoundsFn","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_histogram.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_histogram.ts#L31"},"signature":["(timeRange: ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"},") => ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRangeBounds","text":"TimeRangeBounds"}],"initialIsOpen":false},{"id":"def-common.aggDateRangeFnName","type":"string","label":"aggDateRangeFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/date_range_fn.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/date_range_fn.ts#L15"},"signature":["\"aggDateRange\""],"initialIsOpen":false},{"id":"def-common.aggFilterFnName","type":"string","label":"aggFilterFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/filter_fn.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/filter_fn.ts#L15"},"signature":["\"aggFilter\""],"initialIsOpen":false},{"id":"def-common.aggFiltersFnName","type":"string","label":"aggFiltersFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/filters_fn.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/filters_fn.ts#L15"},"signature":["\"aggFilters\""],"initialIsOpen":false},{"id":"def-common.aggGeoHashFnName","type":"string","label":"aggGeoHashFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/geo_hash_fn.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_hash_fn.ts#L15"},"signature":["\"aggGeoHash\""],"initialIsOpen":false},{"id":"def-common.aggGeoTileFnName","type":"string","label":"aggGeoTileFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/geo_tile_fn.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/geo_tile_fn.ts#L13"},"signature":["\"aggGeoTile\""],"initialIsOpen":false},{"id":"def-common.aggHistogramFnName","type":"string","label":"aggHistogramFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/histogram_fn.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/histogram_fn.ts#L15"},"signature":["\"aggHistogram\""],"initialIsOpen":false},{"id":"def-common.aggIpRangeFnName","type":"string","label":"aggIpRangeFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/ip_range_fn.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/ip_range_fn.ts#L15"},"signature":["\"aggIpRange\""],"initialIsOpen":false},{"id":"def-common.IpRangeKey","type":"Type","label":"IpRangeKey","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/ip_range.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/ip_range.ts#L20"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.CidrMaskIpRangeAggKey","text":"CidrMaskIpRangeAggKey"}," | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.RangeIpRangeAggKey","text":"RangeIpRangeAggKey"}],"initialIsOpen":false},{"id":"def-common.boundsDescendingRaw","type":"Array","label":"boundsDescendingRaw","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/lib/time_buckets/calc_auto_interval.ts#L12"},"signature":["({ bound: number; interval: moment.Duration; boundLabel: string; intervalLabel: string; } | { bound: moment.Duration; interval: moment.Duration; boundLabel: string; intervalLabel: string; })[]"],"initialIsOpen":false},{"id":"def-common.aggRangeFnName","type":"string","label":"aggRangeFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/range_fn.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/range_fn.ts#L15"},"signature":["\"aggRange\""],"initialIsOpen":false},{"id":"def-common.aggSignificantTermsFnName","type":"string","label":"aggSignificantTermsFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/significant_terms_fn.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/significant_terms_fn.ts#L13"},"signature":["\"aggSignificantTerms\""],"initialIsOpen":false},{"id":"def-common.aggTermsFnName","type":"string","label":"aggTermsFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/terms_fn.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms_fn.ts#L14"},"signature":["\"aggTerms\""],"initialIsOpen":false},{"id":"def-common.termsAggFilter","type":"Array","label":"termsAggFilter","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/terms.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/terms.ts#L32"},"signature":["string[]"],"initialIsOpen":false},{"id":"def-common.aggAvgFnName","type":"string","label":"aggAvgFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/avg_fn.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/avg_fn.ts#L13"},"signature":["\"aggAvg\""],"initialIsOpen":false},{"id":"def-common.aggBucketAvgFnName","type":"string","label":"aggBucketAvgFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/bucket_avg_fn.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_avg_fn.ts#L14"},"signature":["\"aggBucketAvg\""],"initialIsOpen":false},{"id":"def-common.aggBucketMaxFnName","type":"string","label":"aggBucketMaxFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/bucket_max_fn.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_max_fn.ts#L14"},"signature":["\"aggBucketMax\""],"initialIsOpen":false},{"id":"def-common.aggBucketMinFnName","type":"string","label":"aggBucketMinFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/bucket_min_fn.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_min_fn.ts#L14"},"signature":["\"aggBucketMin\""],"initialIsOpen":false},{"id":"def-common.aggBucketSumFnName","type":"string","label":"aggBucketSumFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/bucket_sum_fn.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/bucket_sum_fn.ts#L14"},"signature":["\"aggBucketSum\""],"initialIsOpen":false},{"id":"def-common.aggCardinalityFnName","type":"string","label":"aggCardinalityFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/cardinality_fn.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/cardinality_fn.ts#L13"},"signature":["\"aggCardinality\""],"initialIsOpen":false},{"id":"def-common.aggCountFnName","type":"string","label":"aggCountFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/count_fn.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/count_fn.ts#L13"},"signature":["\"aggCount\""],"initialIsOpen":false},{"id":"def-common.aggCumulativeSumFnName","type":"string","label":"aggCumulativeSumFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/cumulative_sum_fn.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/cumulative_sum_fn.ts#L14"},"signature":["\"aggCumulativeSum\""],"initialIsOpen":false},{"id":"def-common.aggDerivativeFnName","type":"string","label":"aggDerivativeFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/derivative_fn.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/derivative_fn.ts#L14"},"signature":["\"aggDerivative\""],"initialIsOpen":false},{"id":"def-common.aggGeoBoundsFnName","type":"string","label":"aggGeoBoundsFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/geo_bounds_fn.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/geo_bounds_fn.ts#L13"},"signature":["\"aggGeoBounds\""],"initialIsOpen":false},{"id":"def-common.aggGeoCentroidFnName","type":"string","label":"aggGeoCentroidFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/geo_centroid_fn.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/geo_centroid_fn.ts#L13"},"signature":["\"aggGeoCentroid\""],"initialIsOpen":false},{"id":"def-common.parentPipelineType","type":"string","label":"parentPipelineType","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts#L26"},"initialIsOpen":false},{"id":"def-common.siblingPipelineType","type":"string","label":"siblingPipelineType","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts#L33"},"initialIsOpen":false},{"id":"def-common.aggMaxFnName","type":"string","label":"aggMaxFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/max_fn.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/max_fn.ts#L13"},"signature":["\"aggMax\""],"initialIsOpen":false},{"id":"def-common.aggMedianFnName","type":"string","label":"aggMedianFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/median_fn.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/median_fn.ts#L13"},"signature":["\"aggMedian\""],"initialIsOpen":false},{"id":"def-common.IMetricAggType","type":"Type","label":"IMetricAggType","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/metric_agg_type.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/metric_agg_type.ts#L35"},"signature":["MetricAggType"],"initialIsOpen":false},{"id":"def-common.aggMinFnName","type":"string","label":"aggMinFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/min_fn.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/min_fn.ts#L13"},"signature":["\"aggMin\""],"initialIsOpen":false},{"id":"def-common.aggMovingAvgFnName","type":"string","label":"aggMovingAvgFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/moving_avg_fn.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/moving_avg_fn.ts#L14"},"signature":["\"aggMovingAvg\""],"initialIsOpen":false},{"id":"def-common.aggPercentileRanksFnName","type":"string","label":"aggPercentileRanksFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/percentile_ranks_fn.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentile_ranks_fn.ts#L13"},"signature":["\"aggPercentileRanks\""],"initialIsOpen":false},{"id":"def-common.IPercentileRanksAggConfig","type":"Type","label":"IPercentileRanksAggConfig","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/percentile_ranks.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentile_ranks.ts#L27"},"signature":["IResponseAggConfig"],"initialIsOpen":false},{"id":"def-common.aggPercentilesFnName","type":"string","label":"aggPercentilesFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/percentiles_fn.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentiles_fn.ts#L13"},"signature":["\"aggPercentiles\""],"initialIsOpen":false},{"id":"def-common.IPercentileAggConfig","type":"Type","label":"IPercentileAggConfig","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/percentiles.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/percentiles.ts#L24"},"signature":["IResponseAggConfig"],"initialIsOpen":false},{"id":"def-common.aggSerialDiffFnName","type":"string","label":"aggSerialDiffFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/serial_diff_fn.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/serial_diff_fn.ts#L14"},"signature":["\"aggSerialDiff\""],"initialIsOpen":false},{"id":"def-common.aggStdDeviationFnName","type":"string","label":"aggStdDeviationFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/std_deviation_fn.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/std_deviation_fn.ts#L13"},"signature":["\"aggStdDeviation\""],"initialIsOpen":false},{"id":"def-common.aggSumFnName","type":"string","label":"aggSumFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/sum_fn.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/sum_fn.ts#L13"},"signature":["\"aggSum\""],"initialIsOpen":false},{"id":"def-common.aggTopHitFnName","type":"string","label":"aggTopHitFnName","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/top_hit_fn.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/top_hit_fn.ts#L13"},"signature":["\"aggTopHit\""],"initialIsOpen":false},{"id":"def-common.FieldTypes","type":"Type","label":"FieldTypes","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/field.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/field.ts#L19"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"},"._SOURCE | ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"},".ATTACHMENT | ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"},".BOOLEAN | ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"},".DATE | ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.KBN_FIELD_TYPES","text":"KBN_FIELD_TYPES"}],"initialIsOpen":false},{"id":"def-common.IFieldParamType","type":"Type","label":"IFieldParamType","description":[],"source":{"path":"src/plugins/data/common/search/aggs/param_types/field.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/param_types/field.ts#L21"},"signature":["FieldParamType"],"initialIsOpen":false},{"id":"def-common.AggParam","type":"Type","label":"AggParam","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_params.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_params.ts#L28"},"signature":["BaseParamType"],"initialIsOpen":false},{"id":"def-common.AggsStart","type":"Type","label":"AggsStart","description":["\nAggsStart represents the actual external contract as AggsCommonStart\nis only used internally. The difference is that AggsStart includes the\ntypings for the registry with initialized agg types.\n"],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":139,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L139"},"signature":["{ calculateAutoTimeExpression: (range: TimeRange) => string | undefined; getDateMetaByDatatableColumn: (column: DatatableColumn) => Promise<{ timeZone: string; timeRange?: TimeRange | undefined; interval: string; } | undefined>; datatableUtilities: { getIndexPattern: (column: DatatableColumn) => Promise; getAggConfig: (column: DatatableColumn) => Promise; isFilterable: (column: DatatableColumn) => boolean; }; createAggConfigs: (indexPattern: IndexPattern, configStates?: Pick & Pick<{ type: string | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IAggType","text":"IAggType"},"; }, \"type\"> & Pick<{ type: string | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IAggType","text":"IAggType"},"; }, never>, \"type\" | \"enabled\" | \"id\" | \"schema\" | \"params\">[] | undefined) => AggConfigs; types: AggTypesRegistryStart; }"],"initialIsOpen":false},{"id":"def-common.AggExpressionFunctionArgs","type":"Type","label":"AggExpressionFunctionArgs","description":[],"source":{"path":"src/plugins/data/common/search/aggs/types.ts","lineNumber":154,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/types.ts#L154"},"signature":["AggParamsMapping[Name] & Pick<{ type: string; enabled?: boolean | undefined; id?: string | undefined; params?: {} | ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined; schema?: string | undefined; }, \"enabled\" | \"id\" | \"schema\">"],"initialIsOpen":false},{"id":"def-common.ParsedInterval","type":"Type","label":"ParsedInterval","description":[],"source":{"path":"src/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/utils/date_interval_utils/parse_es_interval.ts#L18"},"signature":["{ value: number; unit: Unit; type: \"calendar\" | \"fixed\"; }"],"initialIsOpen":false},{"id":"def-common.ES_SEARCH_STRATEGY","type":"string","label":"ES_SEARCH_STRATEGY","description":[],"source":{"path":"src/plugins/data/common/search/es_search/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/es_search/types.ts#L13"},"signature":["\"es\""],"initialIsOpen":false},{"id":"def-common.ISearchRequestParams","type":"Type","label":"ISearchRequestParams","description":[],"source":{"path":"src/plugins/data/common/search/es_search/types.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/es_search/types.ts#L15"},"signature":["{ trackTotalHits?: boolean | undefined; } & Search"],"initialIsOpen":false},{"id":"def-common.IEsSearchResponse","type":"Type","label":"IEsSearchResponse","description":[],"source":{"path":"src/plugins/data/common/search/es_search/types.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/es_search/types.ts#L23"},"signature":["IKibanaSearchResponse>"],"initialIsOpen":false},{"id":"def-common.ExpressionFunctionKibana","type":"Type","label":"ExpressionFunctionKibana","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana.ts#L17"},"signature":["ExpressionFunctionDefinition<\"kibana\", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"kibana_context\", ExecutionContextSearch> | null, object, ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"kibana_context\", ExecutionContextSearch>, ExecutionContext>"],"initialIsOpen":false},{"id":"def-common.ExpressionFunctionKibanaContext","type":"Type","label":"ExpressionFunctionKibanaContext","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L23"},"signature":["ExpressionFunctionDefinition<\"kibana_context\", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"kibana_context\", ExecutionContextSearch> | null, Arguments, Promise<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"kibana_context\", ExecutionContextSearch>>, ExecutionContext>"],"initialIsOpen":false},{"id":"def-common.ExecutionContextSearch","type":"Type","label":"ExecutionContextSearch","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context_type.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L14"},"signature":["{ filters?: Filter[] | undefined; query?: Query | Query[] | undefined; timeRange?: TimeRange | undefined; }"],"initialIsOpen":false},{"id":"def-common.ExpressionValueSearchContext","type":"Type","label":"ExpressionValueSearchContext","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context_type.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L20"},"signature":["{ type: \"kibana_context\"; } & ExecutionContextSearch"],"initialIsOpen":false},{"id":"def-common.KIBANA_CONTEXT_NAME","type":"Type","label":"KIBANA_CONTEXT_NAME","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context_type.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L26"},"signature":["\"kibana_context\""],"initialIsOpen":false},{"id":"def-common.KibanaContext","type":"Type","label":"KibanaContext","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context_type.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L27"},"signature":["{ type: \"kibana_context\"; } & ExecutionContextSearch"],"initialIsOpen":false},{"id":"def-common.EsaggsExpressionFunctionDefinition","type":"Type","label":"EsaggsExpressionFunctionDefinition","description":[],"source":{"path":"src/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/esaggs/esaggs_fn.ts#L35"},"signature":["ExpressionFunctionDefinition<\"esaggs\", Input, Arguments, Output, ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},"<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},">>"],"initialIsOpen":false},{"id":"def-common.SearchRequest","type":"Type","label":"SearchRequest","description":[],"source":{"path":"src/plugins/data/common/search/search_source/fetch/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/fetch/types.ts#L20"},"signature":["{ [x: string]: any; }"],"initialIsOpen":false},{"id":"def-common.searchSourceRequiredUiSettings","type":"Array","label":"searchSourceRequiredUiSettings","description":[],"source":{"path":"src/plugins/data/common/search/search_source/search_source.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/search_source.ts#L84"},"signature":["string[]"],"initialIsOpen":false},{"id":"def-common.ISearchSource","type":"Type","label":"ISearchSource","description":["\nsearch source interface"],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L19"},"signature":["{ create: () => SearchSource; history: Record[]; setPreferredSearchStrategyId: (searchStrategyId: string) => void; setField: (field: K, value: SearchSourceFields[K]) => SearchSource; removeField: (field: K) => SearchSource; setFields: (newFields: SearchSourceFields) => SearchSource; getId: () => string; getFields: () => SearchSourceFields; getField: (field: K, recurse?: boolean) => SearchSourceFields[K]; getOwnField: (field: K) => SearchSourceFields[K]; createCopy: () => SearchSource; createChild: (options?: {}) => SearchSource; setParent: (parent?: Pick | undefined, options?: SearchSourceOptions) => SearchSource; getParent: () => SearchSource | undefined; fetch$: (options?: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"},") => ","Observable","<","SearchResponse",">; fetch: (options?: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"},") => Promise<","SearchResponse"],"initialIsOpen":false},{"id":"def-common.EsQuerySearchAfter","type":"Type","label":"EsQuerySearchAfter","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L37"},"signature":["[","ReactText",", ","ReactText","]"],"initialIsOpen":false},{"id":"def-common.EsQuerySortValue","type":"Type","label":"EsQuerySortValue","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L49"},"signature":["{ [x: string]: SortDirection | SortDirectionNumeric; }"],"initialIsOpen":false},{"id":"def-common.SearchFieldValue","type":"Type","label":"SearchFieldValue","description":[],"source":{"path":"src/plugins/data/common/search/search_source/types.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/search_source/types.ts#L56"},"signature":["string | SearchField"],"initialIsOpen":false},{"id":"def-common.ISearchGeneric","type":"Type","label":"ISearchGeneric","description":[],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L13"},"signature":["(request: SearchStrategyRequest, options: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"}," | undefined) => ","Observable",""],"initialIsOpen":false},{"id":"def-common.ISearchCancelGeneric","type":"Type","label":"ISearchCancelGeneric","description":[],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L21"},"signature":["(id: string, options: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"}," | undefined) => Promise"],"initialIsOpen":false},{"id":"def-common.ISearchExtendGeneric","type":"Type","label":"ISearchExtendGeneric","description":[],"source":{"path":"src/plugins/data/common/search/types.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/types.ts#L22"},"signature":["(id: string, keepAlive: string, options: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ISearchOptions","text":"ISearchOptions"}," | undefined) => Promise"],"initialIsOpen":false}],"objects":[{"id":"def-common.AggGroupNames","type":"Object","label":"AggGroupNames","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_groups.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L12"},"signature":["Readonly<{ Buckets: \"buckets\"; Metrics: \"metrics\"; None: \"none\"; }>"],"initialIsOpen":false},{"id":"def-common.AggGroupLabels","type":"Object","children":[{"id":"def-common.AggGroupLabels.[AggGroupNames.Buckets]","type":"string","label":"[AggGroupNames.Buckets]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_groups.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L21"}},{"id":"def-common.AggGroupLabels.[AggGroupNames.Metrics]","type":"string","label":"[AggGroupNames.Metrics]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_groups.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L24"}},{"id":"def-common.AggGroupLabels.[AggGroupNames.None]","type":"string","label":"[AggGroupNames.None]","description":[],"source":{"path":"src/plugins/data/common/search/aggs/agg_groups.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L27"}}],"description":[],"label":"AggGroupLabels","source":{"path":"src/plugins/data/common/search/aggs/agg_groups.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/agg_groups.ts#L20"},"initialIsOpen":false},{"id":"def-common.migrateIncludeExcludeFormat","type":"Object","label":"migrateIncludeExcludeFormat","description":[],"source":{"path":"src/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/buckets/migrate_include_exclude_format.ts#L25"},"signature":["Partial<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.BucketAggParam","text":"BucketAggParam"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IBucketAggConfig","text":"IBucketAggConfig"},">>"],"initialIsOpen":false},{"id":"def-common.parentPipelineAggHelper","type":"Object","children":[{"id":"def-common.parentPipelineAggHelper.subtype","type":"string","label":"subtype","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts#L34"}},{"id":"def-common.parentPipelineAggHelper.params","type":"Function","label":"params","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggParam","text":"MetricAggParam"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IMetricAggConfig","text":"IMetricAggConfig"},">[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts#L35"}},{"id":"def-common.parentPipelineAggHelper.getSerializedFormat","type":"Function","label":"getSerializedFormat","signature":["(agg: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IMetricAggConfig","text":"IMetricAggConfig"},") => any"],"description":[],"children":[{"type":"Object","label":"agg","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IMetricAggConfig","text":"IMetricAggConfig"}],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts#L63"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts#L63"}}],"description":[],"label":"parentPipelineAggHelper","source":{"path":"src/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/lib/parent_pipeline_agg_helper.ts#L33"},"initialIsOpen":false},{"id":"def-common.siblingPipelineAggHelper","type":"Object","children":[{"id":"def-common.siblingPipelineAggHelper.subtype","type":"string","label":"subtype","description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts#L41"}},{"id":"def-common.siblingPipelineAggHelper.params","type":"Function","label":"params","signature":["() => ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.MetricAggParam","text":"MetricAggParam"},"<",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IMetricAggConfig","text":"IMetricAggConfig"},">[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts#L42"}},{"id":"def-common.siblingPipelineAggHelper.getSerializedFormat","type":"Function","label":"getSerializedFormat","signature":["(agg: ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IMetricAggConfig","text":"IMetricAggConfig"},") => any"],"description":[],"children":[{"type":"Object","label":"agg","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.IMetricAggConfig","text":"IMetricAggConfig"}],"description":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts#L77"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts#L77"}}],"description":[],"label":"siblingPipelineAggHelper","source":{"path":"src/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/aggs/metrics/lib/sibling_pipeline_agg_helper.ts#L40"},"initialIsOpen":false},{"id":"def-common.kibana","type":"Object","children":[{"id":"def-common.kibana.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana.ts#L27"},"signature":["\"kibana\""]},{"id":"def-common.kibana.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana.ts#L28"},"signature":["\"kibana_context\""]},{"id":"def-common.kibana.inputTypes","type":"Array","label":"inputTypes","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana.ts#L30"},"signature":["(\"kibana_context\" | \"null\")[]"]},{"id":"def-common.kibana.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana.ts#L32"}},{"id":"def-common.kibana.args","type":"Object","children":[],"description":[],"label":"args","source":{"path":"src/plugins/data/common/search/expressions/kibana.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana.ts#L36"}},{"id":"def-common.kibana.fn","type":"Function","label":"fn","signature":["(input: Input, _: object, { getSearchContext }: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},"<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ExecutionContextSearch","text":"ExecutionContextSearch"},">) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"kibana_context\", ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ExecutionContextSearch","text":"ExecutionContextSearch"}],"description":[],"children":[{"type":"CompoundType","label":"input","isRequired":false,"signature":["Input"],"description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana.ts#L38"}},{"type":"Uncategorized","label":"_","isRequired":true,"signature":["object"],"description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana.ts#L38"}},{"type":"Object","label":"{ getSearchContext }","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},"<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ExecutionContextSearch","text":"ExecutionContextSearch"},">"],"description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana.ts#L38"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana.ts#L38"}}],"description":[],"label":"kibana","source":{"path":"src/plugins/data/common/search/expressions/kibana.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana.ts#L26"},"initialIsOpen":false},{"id":"def-common.kibanaContextFunction","type":"Object","children":[{"id":"def-common.kibanaContextFunction.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L41"},"signature":["\"kibana_context\""]},{"id":"def-common.kibanaContextFunction.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L42"},"signature":["\"kibana_context\""]},{"id":"def-common.kibanaContextFunction.inputTypes","type":"Array","label":"inputTypes","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L43"},"signature":["(\"kibana_context\" | \"null\")[]"]},{"id":"def-common.kibanaContextFunction.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L44"}},{"id":"def-common.kibanaContextFunction.args","type":"Object","children":[{"id":"def-common.kibanaContextFunction.args.q","type":"Object","children":[{"id":"def-common.kibanaContextFunction.args.q.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L49"},"signature":["(\"string\" | \"null\")[]"]},{"id":"def-common.kibanaContextFunction.args.q.aliases","type":"Array","label":"aliases","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L50"},"signature":["string[]"]},{"id":"def-common.kibanaContextFunction.args.q.default","type":"Uncategorized","label":"default","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L51"},"signature":["null"]},{"id":"def-common.kibanaContextFunction.args.q.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L52"}}],"description":[],"label":"q","source":{"path":"src/plugins/data/common/search/expressions/kibana_context.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L48"}},{"id":"def-common.kibanaContextFunction.args.filters","type":"Object","children":[{"id":"def-common.kibanaContextFunction.args.filters.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L57"},"signature":["(\"string\" | \"null\")[]"]},{"id":"def-common.kibanaContextFunction.args.filters.default","type":"string","label":"default","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L58"}},{"id":"def-common.kibanaContextFunction.args.filters.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L59"}}],"description":[],"label":"filters","source":{"path":"src/plugins/data/common/search/expressions/kibana_context.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L56"}},{"id":"def-common.kibanaContextFunction.args.timeRange","type":"Object","children":[{"id":"def-common.kibanaContextFunction.args.timeRange.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L64"},"signature":["(\"string\" | \"null\")[]"]},{"id":"def-common.kibanaContextFunction.args.timeRange.default","type":"Uncategorized","label":"default","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L65"},"signature":["null"]},{"id":"def-common.kibanaContextFunction.args.timeRange.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L66"}}],"description":[],"label":"timeRange","source":{"path":"src/plugins/data/common/search/expressions/kibana_context.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L63"}},{"id":"def-common.kibanaContextFunction.args.savedSearchId","type":"Object","children":[{"id":"def-common.kibanaContextFunction.args.savedSearchId.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L71"},"signature":["(\"string\" | \"null\")[]"]},{"id":"def-common.kibanaContextFunction.args.savedSearchId.default","type":"Uncategorized","label":"default","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L72"},"signature":["null"]},{"id":"def-common.kibanaContextFunction.args.savedSearchId.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L73"}}],"description":[],"label":"savedSearchId","source":{"path":"src/plugins/data/common/search/expressions/kibana_context.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L70"}}],"description":[],"label":"args","source":{"path":"src/plugins/data/common/search/expressions/kibana_context.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L47"}},{"id":"def-common.kibanaContextFunction.fn","type":"Function","label":"fn","signature":["(input: Input, args: Arguments, { getSavedObject }: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},"<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ExecutionContextSearch","text":"ExecutionContextSearch"},">) => Promise<{ type: \"kibana_context\"; query: ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.Query","text":"Query"},"[]; filters: ",{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"}],"description":[],"children":[{"type":"CompoundType","label":"input","isRequired":false,"signature":["Input"],"description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L79"}},{"type":"Object","label":"args","isRequired":true,"signature":["Arguments"],"description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L79"}},{"type":"Object","label":"{ getSavedObject }","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},"<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", ",{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.ExecutionContextSearch","text":"ExecutionContextSearch"},">"],"description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L79"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L79"}}],"description":[],"label":"kibanaContextFunction","source":{"path":"src/plugins/data/common/search/expressions/kibana_context.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context.ts#L40"},"initialIsOpen":false},{"id":"def-common.kibanaContext","type":"Object","children":[{"id":"def-common.kibanaContext.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/data/common/search/expressions/kibana_context_type.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L30"}},{"id":"def-common.kibanaContext.from","type":"Object","children":[{"id":"def-common.kibanaContext.from.null","type":"Function","children":[],"signature":["() => { type: string; }"],"description":[],"label":"null","source":{"path":"src/plugins/data/common/search/expressions/kibana_context_type.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L32"},"returnComment":[]}],"description":[],"label":"from","source":{"path":"src/plugins/data/common/search/expressions/kibana_context_type.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L31"}},{"id":"def-common.kibanaContext.to","type":"Object","children":[{"id":"def-common.kibanaContext.to.null","type":"Function","children":[],"signature":["() => { type: string; }"],"description":[],"label":"null","source":{"path":"src/plugins/data/common/search/expressions/kibana_context_type.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L39"},"returnComment":[]}],"description":[],"label":"to","source":{"path":"src/plugins/data/common/search/expressions/kibana_context_type.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L38"}}],"description":[],"label":"kibanaContext","source":{"path":"src/plugins/data/common/search/expressions/kibana_context_type.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/common/search/expressions/kibana_context_type.ts#L29"},"initialIsOpen":false}]}} \ No newline at end of file diff --git a/api_docs/data_search.mdx b/api_docs/data_search.mdx new file mode 100644 index 0000000000000..caa3b928e3c1c --- /dev/null +++ b/api_docs/data_search.mdx @@ -0,0 +1,48 @@ +--- +id: kibDataSearchPluginApi +slug: /kibana-dev-docs/data.searchPluginApi +title: data.search +image: https://source.unsplash.com/400x175/?github +summary: API docs for the data.search plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.search'] +--- + +import dataSearchObj from './data_search.json'; + +## Client + +### Functions + +### Classes + +### Interfaces + +### Enums + +### Consts, variables and types + +## Server + +### Functions + +### Classes + +### Interfaces + +### Consts, variables and types + +## Common + +### Objects + +### Functions + +### Classes + +### Interfaces + +### Enums + +### Consts, variables and types + diff --git a/api_docs/data_ui.json b/api_docs/data_ui.json new file mode 100644 index 0000000000000..4801779b16b38 --- /dev/null +++ b/api_docs/data_ui.json @@ -0,0 +1 @@ +{"id":"data.ui","client":{"classes":[],"functions":[{"id":"def-public.QueryStringInput","type":"Function","children":[{"type":"Object","label":"props","isRequired":true,"signature":[{"pluginId":"data","scope":"public","docId":"kibDataUiPluginApi","section":"def-public.QueryStringInputProps","text":"QueryStringInputProps"}],"description":[],"source":{"path":"src/plugins/data/public/ui/query_string_input/index.tsx","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/index.tsx#L24"}}],"signature":["(props: ",{"pluginId":"data","scope":"public","docId":"kibDataUiPluginApi","section":"def-public.QueryStringInputProps","text":"QueryStringInputProps"},") => JSX.Element"],"description":[],"label":"QueryStringInput","source":{"path":"src/plugins/data/public/ui/query_string_input/index.tsx","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/index.tsx#L24"},"returnComment":[],"initialIsOpen":false}],"interfaces":[{"id":"def-public.QueryStringInputProps","type":"Interface","label":"QueryStringInputProps","description":[],"children":[{"id":"def-public.QueryStringInputProps.indexPatterns","type":"Array","label":"indexPatterns","description":[],"source":{"path":"src/plugins/data/public/ui/query_string_input/query_string_input.tsx","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L42"},"signature":["(string | ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"},")[]"]},{"id":"def-public.QueryStringInputProps.query","type":"Object","label":"query","description":[],"source":{"path":"src/plugins/data/public/ui/query_string_input/query_string_input.tsx","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L43"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.Query","text":"Query"}]},{"id":"def-public.QueryStringInputProps.disableAutoFocus","type":"CompoundType","label":"disableAutoFocus","description":[],"source":{"path":"src/plugins/data/public/ui/query_string_input/query_string_input.tsx","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L44"},"signature":["boolean | undefined"]},{"id":"def-public.QueryStringInputProps.screenTitle","type":"string","label":"screenTitle","description":[],"source":{"path":"src/plugins/data/public/ui/query_string_input/query_string_input.tsx","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L45"},"signature":["string | undefined"]},{"id":"def-public.QueryStringInputProps.prepend","type":"Any","label":"prepend","description":[],"source":{"path":"src/plugins/data/public/ui/query_string_input/query_string_input.tsx","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L46"},"signature":["any"]},{"id":"def-public.QueryStringInputProps.persistedLog","type":"Object","label":"persistedLog","description":[],"source":{"path":"src/plugins/data/public/ui/query_string_input/query_string_input.tsx","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L47"},"signature":[{"pluginId":"data","scope":"public","docId":"kibDataQueryPluginApi","section":"def-public.PersistedLog","text":"PersistedLog"}," | undefined"]},{"id":"def-public.QueryStringInputProps.bubbleSubmitEvent","type":"CompoundType","label":"bubbleSubmitEvent","description":[],"source":{"path":"src/plugins/data/public/ui/query_string_input/query_string_input.tsx","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L48"},"signature":["boolean | undefined"]},{"id":"def-public.QueryStringInputProps.placeholder","type":"string","label":"placeholder","description":[],"source":{"path":"src/plugins/data/public/ui/query_string_input/query_string_input.tsx","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L49"},"signature":["string | undefined"]},{"id":"def-public.QueryStringInputProps.disableLanguageSwitcher","type":"CompoundType","label":"disableLanguageSwitcher","description":[],"source":{"path":"src/plugins/data/public/ui/query_string_input/query_string_input.tsx","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L50"},"signature":["boolean | undefined"]},{"id":"def-public.QueryStringInputProps.languageSwitcherPopoverAnchorPosition","type":"CompoundType","label":"languageSwitcherPopoverAnchorPosition","description":[],"source":{"path":"src/plugins/data/public/ui/query_string_input/query_string_input.tsx","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L51"},"signature":["\"upCenter\" | \"upLeft\" | \"upRight\" | \"downCenter\" | \"downLeft\" | \"downRight\" | \"leftCenter\" | \"leftUp\" | \"leftDown\" | \"rightCenter\" | \"rightUp\" | \"rightDown\" | undefined"]},{"id":"def-public.QueryStringInputProps.onBlur","type":"Function","label":"onBlur","description":[],"source":{"path":"src/plugins/data/public/ui/query_string_input/query_string_input.tsx","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L52"},"signature":["(() => void) | undefined"]},{"id":"def-public.QueryStringInputProps.onChange","type":"Function","label":"onChange","description":[],"source":{"path":"src/plugins/data/public/ui/query_string_input/query_string_input.tsx","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L53"},"signature":["((query: ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.Query","text":"Query"},") => void) | undefined"]},{"id":"def-public.QueryStringInputProps.onChangeQueryInputFocus","type":"Function","label":"onChangeQueryInputFocus","description":[],"source":{"path":"src/plugins/data/public/ui/query_string_input/query_string_input.tsx","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L54"},"signature":["((isFocused: boolean) => void) | undefined"]},{"id":"def-public.QueryStringInputProps.onSubmit","type":"Function","label":"onSubmit","description":[],"source":{"path":"src/plugins/data/public/ui/query_string_input/query_string_input.tsx","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L55"},"signature":["((query: ",{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.Query","text":"Query"},") => void) | undefined"]},{"id":"def-public.QueryStringInputProps.dataTestSubj","type":"string","label":"dataTestSubj","description":[],"source":{"path":"src/plugins/data/public/ui/query_string_input/query_string_input.tsx","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L56"},"signature":["string | undefined"]},{"id":"def-public.QueryStringInputProps.size","type":"CompoundType","label":"size","description":[],"source":{"path":"src/plugins/data/public/ui/query_string_input/query_string_input.tsx","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L57"},"signature":["\"s\" | \"l\" | undefined"]},{"id":"def-public.QueryStringInputProps.className","type":"string","label":"className","description":[],"source":{"path":"src/plugins/data/public/ui/query_string_input/query_string_input.tsx","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L58"},"signature":["string | undefined"]},{"id":"def-public.QueryStringInputProps.isInvalid","type":"CompoundType","label":"isInvalid","description":[],"source":{"path":"src/plugins/data/public/ui/query_string_input/query_string_input.tsx","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L59"},"signature":["boolean | undefined"]},{"id":"def-public.QueryStringInputProps.isClearable","type":"CompoundType","label":"isClearable","description":[],"source":{"path":"src/plugins/data/public/ui/query_string_input/query_string_input.tsx","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L60"},"signature":["boolean | undefined"]},{"id":"def-public.QueryStringInputProps.iconType","type":"CompoundType","label":"iconType","description":[],"source":{"path":"src/plugins/data/public/ui/query_string_input/query_string_input.tsx","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L61"},"signature":["string | React.ComponentClass<{}, any> | React.FunctionComponent<{}> | undefined"]},{"id":"def-public.QueryStringInputProps.nonKqlMode","type":"CompoundType","label":"nonKqlMode","description":[],"source":{"path":"src/plugins/data/public/ui/query_string_input/query_string_input.tsx","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L67"},"signature":["\"text\" | \"lucene\" | undefined"]},{"id":"def-public.QueryStringInputProps.nonKqlModeHelpText","type":"string","label":"nonKqlModeHelpText","description":[],"source":{"path":"src/plugins/data/public/ui/query_string_input/query_string_input.tsx","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L68"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/data/public/ui/query_string_input/query_string_input.tsx","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/query_string_input/query_string_input.tsx#L41"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-public.SearchBar","type":"CompoundType","label":"SearchBar","description":[],"source":{"path":"src/plugins/data/public/ui/search_bar/index.tsx","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/search_bar/index.tsx#L23"},"signature":["React.ComponentClass, \"filters\" | \"query\" | \"indexPatterns\" | \"isLoading\" | \"customSubmitButton\" | \"screenTitle\" | \"dataTestSubj\" | \"showQueryBar\" | \"showQueryInput\" | \"showFilterBar\" | \"showDatePicker\" | \"showAutoRefreshOnly\" | \"isRefreshPaused\" | \"refreshInterval\" | \"dateRangeFrom\" | \"dateRangeTo\" | \"showSaveQuery\" | \"savedQuery\" | \"onQueryChange\" | \"onQuerySubmit\" | \"onSaved\" | \"onSavedQueryUpdated\" | \"onClearSavedQuery\" | \"onRefresh\" | \"indicateNoData\" | \"placeholder\" | \"isClearable\" | \"iconType\" | \"nonKqlMode\" | \"nonKqlModeHelpText\" | \"timeHistory\" | \"onFiltersUpdated\" | \"onRefreshChange\">, any> & { WrappedComponent: React.ComponentType & ReactIntl.InjectedIntlProps>; }"],"initialIsOpen":false},{"id":"def-public.SearchBarProps","type":"Type","label":"SearchBarProps","description":[],"source":{"path":"src/plugins/data/public/ui/search_bar/search_bar.tsx","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/search_bar/search_bar.tsx#L80"},"signature":["SearchBarOwnProps & SearchBarInjectedDeps"],"initialIsOpen":false},{"id":"def-public.StatefulSearchBarProps","type":"Type","label":"StatefulSearchBarProps","description":[],"source":{"path":"src/plugins/data/public/ui/search_bar/create_search_bar.tsx","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/search_bar/create_search_bar.tsx#L31"},"signature":["SearchBarOwnProps & { appName: string; useDefaultBehaviors?: boolean | undefined; savedQueryId?: string | undefined; onSavedQueryIdChange?: ((savedQueryId?: string | undefined) => void) | undefined; }"],"initialIsOpen":false},{"id":"def-public.IndexPatternSelectProps","type":"Type","label":"IndexPatternSelectProps","description":[],"source":{"path":"src/plugins/data/public/ui/index_pattern_select/index_pattern_select.tsx","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/data/public/ui/index_pattern_select/index_pattern_select.tsx#L17"},"signature":["Pick, \"children\" | \"onClick\" | \"color\" | \"id\" | \"title\" | \"placeholder\" | \"isClearable\" | \"async\" | \"compressed\" | \"fullWidth\" | \"singleSelection\" | \"prepend\" | \"append\" | \"sortMatchesBy\" | \"defaultChecked\" | \"defaultValue\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"className\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"security\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDown\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"css\" | \"data-test-subj\" | \"customOptionText\" | \"onCreateOption\" | \"renderOption\" | \"inputRef\" | \"isDisabled\" | \"isInvalid\" | \"noSuggestions\" | \"rowHeight\" | \"delimiter\">, \"children\" | \"onClick\" | \"color\" | \"id\" | \"title\" | \"isClearable\" | \"async\" | \"compressed\" | \"fullWidth\" | \"singleSelection\" | \"prepend\" | \"append\" | \"sortMatchesBy\" | \"defaultChecked\" | \"defaultValue\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"className\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"security\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDown\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"css\" | \"data-test-subj\" | \"customOptionText\" | \"onCreateOption\" | \"renderOption\" | \"inputRef\" | \"isDisabled\" | \"isInvalid\" | \"noSuggestions\" | \"rowHeight\" | \"delimiter\"> & globalThis.Required, \"children\" | \"onClick\" | \"color\" | \"id\" | \"title\" | \"placeholder\" | \"isClearable\" | \"async\" | \"compressed\" | \"fullWidth\" | \"singleSelection\" | \"prepend\" | \"append\" | \"sortMatchesBy\" | \"defaultChecked\" | \"defaultValue\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"className\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"security\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDown\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"css\" | \"data-test-subj\" | \"customOptionText\" | \"onCreateOption\" | \"renderOption\" | \"inputRef\" | \"isDisabled\" | \"isInvalid\" | \"noSuggestions\" | \"rowHeight\" | \"delimiter\">, \"placeholder\">> & { onChange: (indexPatternId?: string | undefined) => void; indexPatternId: string; fieldTypes?: string[] | undefined; onNoIndexPatterns?: (() => void) | undefined; maxIndexPatterns?: number | undefined; }"],"initialIsOpen":false}],"objects":[]},"server":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]}} \ No newline at end of file diff --git a/api_docs/data_ui.mdx b/api_docs/data_ui.mdx new file mode 100644 index 0000000000000..36f71f3d1ef46 --- /dev/null +++ b/api_docs/data_ui.mdx @@ -0,0 +1,20 @@ +--- +id: kibDataUiPluginApi +slug: /kibana-dev-docs/data.uiPluginApi +title: data.ui +image: https://source.unsplash.com/400x175/?github +summary: API docs for the data.ui plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'data.ui'] +--- + +import dataUiObj from './data_ui.json'; + +## Client + +### Functions + +### Interfaces + +### Consts, variables and types + diff --git a/api_docs/dev_tools.json b/api_docs/dev_tools.json new file mode 100644 index 0000000000000..078566874afd6 --- /dev/null +++ b/api_docs/dev_tools.json @@ -0,0 +1 @@ +{"id":"devTools","client":{"classes":[{"id":"def-public.DevToolsPlugin","type":"Class","label":"DevToolsPlugin","description":[],"signature":[{"pluginId":"devTools","scope":"public","docId":"kibDevToolsPluginApi","section":"def-public.DevToolsPlugin","text":"DevToolsPlugin"}," implements ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Plugin","text":"Plugin"},"<",{"pluginId":"devTools","scope":"public","docId":"kibDevToolsPluginApi","section":"def-public.DevToolsSetup","text":"DevToolsSetup"},", void, object, object>"],"children":[{"id":"def-public.DevToolsPlugin.setup","type":"Function","label":"setup","signature":["(coreSetup: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreSetup","text":"CoreSetup"},", { urlForwarding }: { urlForwarding: { forwardApp: (legacyAppId: string, newAppId: string, rewritePath?: ((legacyPath: string) => string) | undefined) => void; }; }) => { register: (devToolArgs: ",{"pluginId":"devTools","scope":"public","docId":"kibDevToolsPluginApi","section":"def-public.CreateDevToolArgs","text":"CreateDevToolArgs"},") => ",{"pluginId":"devTools","scope":"public","docId":"kibDevToolsPluginApi","section":"def-public.DevToolApp","text":"DevToolApp"},"; }"],"description":[],"children":[{"type":"Object","label":"coreSetup","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreSetup","text":"CoreSetup"},""],"description":[],"source":{"path":"src/plugins/dev_tools/public/plugin.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L43"}},{"id":"def-public.DevToolsPlugin.setup.{-urlForwarding }","type":"Object","label":"{ urlForwarding }","description":[],"children":[{"id":"def-public.DevToolsPlugin.setup.{-urlForwarding }.urlForwarding","type":"Object","label":"urlForwarding","description":[],"source":{"path":"src/plugins/dev_tools/public/plugin.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L43"},"signature":["{ forwardApp: (legacyAppId: string, newAppId: string, rewritePath?: ((legacyPath: string) => string) | undefined) => void; }"]}],"source":{"path":"src/plugins/dev_tools/public/plugin.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L43"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/dev_tools/public/plugin.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L43"}},{"id":"def-public.DevToolsPlugin.start","type":"Function","label":"start","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/dev_tools/public/plugin.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L84"}},{"id":"def-public.DevToolsPlugin.stop","type":"Function","label":"stop","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/dev_tools/public/plugin.ts","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L90"}}],"source":{"path":"src/plugins/dev_tools/public/plugin.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L35"},"initialIsOpen":false}],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[],"setup":{"id":"def-public.DevToolsSetup","type":"Interface","label":"DevToolsSetup","description":[],"children":[{"id":"def-public.DevToolsSetup.register","type":"Function","label":"register","description":["\nRegister a developer tool. It will be available\nin the dev tools app under a separate tab.\n\nRegistering dev tools works almost similar to registering\napplications in the core application service,\nbut they will be rendered with a frame containing tabs\nto switch between the tools."],"source":{"path":"src/plugins/dev_tools/public/plugin.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L32"},"signature":["(devTool: ",{"pluginId":"devTools","scope":"public","docId":"kibDevToolsPluginApi","section":"def-public.CreateDevToolArgs","text":"CreateDevToolArgs"},") => ",{"pluginId":"devTools","scope":"public","docId":"kibDevToolsPluginApi","section":"def-public.DevToolApp","text":"DevToolApp"}]}],"source":{"path":"src/plugins/dev_tools/public/plugin.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/dev_tools/public/plugin.ts#L21"},"lifecycle":"setup","initialIsOpen":true}},"server":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]}} \ No newline at end of file diff --git a/api_docs/dev_tools.mdx b/api_docs/dev_tools.mdx new file mode 100644 index 0000000000000..a6c02effc9c05 --- /dev/null +++ b/api_docs/dev_tools.mdx @@ -0,0 +1,18 @@ +--- +id: kibDevToolsPluginApi +slug: /kibana-dev-docs/devToolsPluginApi +title: devTools +image: https://source.unsplash.com/400x175/?github +summary: API docs for the devTools plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'devTools'] +--- + +import devToolsObj from './dev_tools.json'; + +## Client + +### Setup + +### Classes + diff --git a/api_docs/discover.json b/api_docs/discover.json new file mode 100644 index 0000000000000..d1f64255af728 --- /dev/null +++ b/api_docs/discover.json @@ -0,0 +1 @@ +{"id":"discover","client":{"classes":[],"functions":[{"id":"def-public.createSavedSearchesLoader","type":"Function","label":"createSavedSearchesLoader","signature":["({ savedObjectsClient, savedObjects }: Services) => ",{"pluginId":"savedObjects","scope":"public","docId":"kibSavedObjectsPluginApi","section":"def-public.SavedObjectLoader","text":"SavedObjectLoader"}],"description":[],"children":[{"type":"Object","label":"{ savedObjectsClient, savedObjects }","isRequired":true,"signature":["Services"],"description":[],"source":{"path":"src/plugins/discover/public/saved_searches/saved_searches.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/saved_searches.ts#L18"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/discover/public/saved_searches/saved_searches.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/saved_searches.ts#L18"},"initialIsOpen":false}],"interfaces":[{"id":"def-public.SavedSearch","type":"Interface","label":"SavedSearch","description":[],"children":[{"id":"def-public.SavedSearch.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/discover/public/saved_searches/types.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L15"}},{"id":"def-public.SavedSearch.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/discover/public/saved_searches/types.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L16"}},{"id":"def-public.SavedSearch.searchSource","type":"Object","label":"searchSource","description":[],"source":{"path":"src/plugins/discover/public/saved_searches/types.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L17"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataSearchPluginApi","section":"def-common.SearchSource","text":"SearchSource"}]},{"id":"def-public.SavedSearch.description","type":"string","label":"description","description":[],"source":{"path":"src/plugins/discover/public/saved_searches/types.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L18"},"signature":["string | undefined"]},{"id":"def-public.SavedSearch.columns","type":"Array","label":"columns","description":[],"source":{"path":"src/plugins/discover/public/saved_searches/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L19"},"signature":["string[]"]},{"id":"def-public.SavedSearch.sort","type":"Array","label":"sort","description":[],"source":{"path":"src/plugins/discover/public/saved_searches/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L20"},"signature":[{"pluginId":"discover","scope":"public","docId":"kibDiscoverPluginApi","section":"def-public.SortOrder","text":"SortOrder"},"[]"]},{"id":"def-public.SavedSearch.grid","type":"Object","label":"grid","description":[],"source":{"path":"src/plugins/discover/public/saved_searches/types.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L21"},"signature":[{"pluginId":"discover","scope":"public","docId":"kibDiscoverPluginApi","section":"def-public.DiscoverGridSettings","text":"DiscoverGridSettings"}]},{"id":"def-public.SavedSearch.destroy","type":"Function","label":"destroy","description":[],"source":{"path":"src/plugins/discover/public/saved_searches/types.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L22"},"signature":["() => void"]},{"id":"def-public.SavedSearch.save","type":"Function","label":"save","description":[],"source":{"path":"src/plugins/discover/public/saved_searches/types.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L23"},"signature":["(saveOptions: ",{"pluginId":"savedObjects","scope":"public","docId":"kibSavedObjectsPluginApi","section":"def-public.SavedObjectSaveOpts","text":"SavedObjectSaveOpts"},") => Promise"]},{"id":"def-public.SavedSearch.lastSavedTitle","type":"string","label":"lastSavedTitle","description":[],"source":{"path":"src/plugins/discover/public/saved_searches/types.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L24"},"signature":["string | undefined"]},{"id":"def-public.SavedSearch.copyOnSave","type":"CompoundType","label":"copyOnSave","description":[],"source":{"path":"src/plugins/discover/public/saved_searches/types.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L25"},"signature":["boolean | undefined"]},{"id":"def-public.SavedSearch.hideChart","type":"CompoundType","label":"hideChart","description":[],"source":{"path":"src/plugins/discover/public/saved_searches/types.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L26"},"signature":["boolean | undefined"]}],"source":{"path":"src/plugins/discover/public/saved_searches/types.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L14"},"initialIsOpen":false},{"id":"def-public.SavedSearchLoader","type":"Interface","label":"SavedSearchLoader","description":[],"children":[{"id":"def-public.SavedSearchLoader.get","type":"Function","label":"get","description":[],"source":{"path":"src/plugins/discover/public/saved_searches/types.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L29"},"signature":["(id: string) => Promise<",{"pluginId":"discover","scope":"public","docId":"kibDiscoverPluginApi","section":"def-public.SavedSearch","text":"SavedSearch"},">"]},{"id":"def-public.SavedSearchLoader.urlFor","type":"Function","label":"urlFor","description":[],"source":{"path":"src/plugins/discover/public/saved_searches/types.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L30"},"signature":["(id: string) => string"]}],"source":{"path":"src/plugins/discover/public/saved_searches/types.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/saved_searches/types.ts#L28"},"initialIsOpen":false},{"id":"def-public.ISearchEmbeddable","type":"Interface","label":"ISearchEmbeddable","signature":[{"pluginId":"discover","scope":"public","docId":"kibDiscoverPluginApi","section":"def-public.ISearchEmbeddable","text":"ISearchEmbeddable"}," extends ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IEmbeddable","text":"IEmbeddable"},"<",{"pluginId":"discover","scope":"public","docId":"kibDiscoverPluginApi","section":"def-public.SearchInput","text":"SearchInput"},", ","SearchOutput",">"],"description":[],"children":[{"id":"def-public.ISearchEmbeddable.getSavedSearch","type":"Function","label":"getSavedSearch","signature":["() => ",{"pluginId":"discover","scope":"public","docId":"kibDiscoverPluginApi","section":"def-public.SavedSearch","text":"SavedSearch"}],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/discover/public/application/embeddable/types.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/application/embeddable/types.ts#L35"}}],"source":{"path":"src/plugins/discover/public/application/embeddable/types.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/application/embeddable/types.ts#L34"},"initialIsOpen":false},{"id":"def-public.SearchInput","type":"Interface","label":"SearchInput","signature":[{"pluginId":"discover","scope":"public","docId":"kibDiscoverPluginApi","section":"def-public.SearchInput","text":"SearchInput"}," extends ",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"}],"description":[],"children":[{"id":"def-public.SearchInput.timeRange","type":"Object","label":"timeRange","description":[],"source":{"path":"src/plugins/discover/public/application/embeddable/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/application/embeddable/types.ts#L20"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"}]},{"id":"def-public.SearchInput.query","type":"Object","label":"query","description":[],"source":{"path":"src/plugins/discover/public/application/embeddable/types.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/application/embeddable/types.ts#L21"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.Query","text":"Query"}," | undefined"]},{"id":"def-public.SearchInput.filters","type":"Array","label":"filters","description":[],"source":{"path":"src/plugins/discover/public/application/embeddable/types.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/application/embeddable/types.ts#L22"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[] | undefined"]},{"id":"def-public.SearchInput.hidePanelTitles","type":"CompoundType","label":"hidePanelTitles","description":[],"source":{"path":"src/plugins/discover/public/application/embeddable/types.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/application/embeddable/types.ts#L23"},"signature":["boolean | undefined"]},{"id":"def-public.SearchInput.columns","type":"Array","label":"columns","description":[],"source":{"path":"src/plugins/discover/public/application/embeddable/types.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/application/embeddable/types.ts#L24"},"signature":["string[] | undefined"]},{"id":"def-public.SearchInput.sort","type":"Array","label":"sort","description":[],"source":{"path":"src/plugins/discover/public/application/embeddable/types.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/application/embeddable/types.ts#L25"},"signature":[{"pluginId":"discover","scope":"public","docId":"kibDiscoverPluginApi","section":"def-public.SortOrder","text":"SortOrder"},"[] | undefined"]}],"source":{"path":"src/plugins/discover/public/application/embeddable/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/application/embeddable/types.ts#L19"},"initialIsOpen":false},{"id":"def-public.DiscoverUrlGeneratorState","type":"Interface","label":"DiscoverUrlGeneratorState","description":[],"children":[{"id":"def-public.DiscoverUrlGeneratorState.savedSearchId","type":"string","label":"savedSearchId","description":["\nOptionally set saved search ID."],"source":{"path":"src/plugins/discover/public/url_generator.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L26"},"signature":["string | undefined"]},{"id":"def-public.DiscoverUrlGeneratorState.indexPatternId","type":"string","label":"indexPatternId","description":["\nOptionally set index pattern ID."],"source":{"path":"src/plugins/discover/public/url_generator.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L31"},"signature":["string | undefined"]},{"id":"def-public.DiscoverUrlGeneratorState.timeRange","type":"Object","label":"timeRange","description":["\nOptionally set the time range in the time picker."],"source":{"path":"src/plugins/discover/public/url_generator.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L36"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.TimeRange","text":"TimeRange"}," | undefined"]},{"id":"def-public.DiscoverUrlGeneratorState.refreshInterval","type":"Object","label":"refreshInterval","description":["\nOptionally set the refresh interval."],"source":{"path":"src/plugins/discover/public/url_generator.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L41"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.RefreshInterval","text":"RefreshInterval"}," | undefined"]},{"id":"def-public.DiscoverUrlGeneratorState.filters","type":"Array","label":"filters","description":["\nOptionally apply filters."],"source":{"path":"src/plugins/discover/public/url_generator.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L46"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataPluginApi","section":"def-common.Filter","text":"Filter"},"[] | undefined"]},{"id":"def-public.DiscoverUrlGeneratorState.query","type":"Object","label":"query","description":["\nOptionally set a query. NOTE: if given and used in conjunction with `dashboardId`, and the\nsaved dashboard has a query saved with it, this will _replace_ that query."],"source":{"path":"src/plugins/discover/public/url_generator.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L52"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataQueryPluginApi","section":"def-common.Query","text":"Query"}," | undefined"]},{"id":"def-public.DiscoverUrlGeneratorState.useHash","type":"CompoundType","label":"useHash","description":["\nIf not given, will use the uiSettings configuration for `storeInSessionStorage`. useHash determines\nwhether to hash the data in the url to avoid url length issues."],"source":{"path":"src/plugins/discover/public/url_generator.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L58"},"signature":["boolean | undefined"]},{"id":"def-public.DiscoverUrlGeneratorState.searchSessionId","type":"string","label":"searchSessionId","description":["\nBackground search session id"],"source":{"path":"src/plugins/discover/public/url_generator.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L63"},"signature":["string | undefined"]},{"id":"def-public.DiscoverUrlGeneratorState.columns","type":"Array","label":"columns","description":["\nColumns displayed in the table"],"source":{"path":"src/plugins/discover/public/url_generator.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L68"},"signature":["string[] | undefined"]},{"id":"def-public.DiscoverUrlGeneratorState.interval","type":"string","label":"interval","description":["\nUsed interval of the histogram"],"source":{"path":"src/plugins/discover/public/url_generator.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L73"},"signature":["string | undefined"]},{"id":"def-public.DiscoverUrlGeneratorState.sort","type":"Array","label":"sort","description":["\nArray of the used sorting [[field,direction],...]"],"source":{"path":"src/plugins/discover/public/url_generator.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L77"},"signature":["string[][] | undefined"]},{"id":"def-public.DiscoverUrlGeneratorState.savedQuery","type":"string","label":"savedQuery","description":["\nid of the used saved query"],"source":{"path":"src/plugins/discover/public/url_generator.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L81"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/discover/public/url_generator.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L22"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-public.SEARCH_EMBEDDABLE_TYPE","type":"string","label":"SEARCH_EMBEDDABLE_TYPE","description":[],"source":{"path":"src/plugins/discover/public/application/embeddable/constants.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/application/embeddable/constants.ts#L9"},"signature":["\"search\""],"initialIsOpen":false},{"id":"def-public.DISCOVER_APP_URL_GENERATOR","type":"string","label":"DISCOVER_APP_URL_GENERATOR","description":[],"source":{"path":"src/plugins/discover/public/url_generator.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/url_generator.ts#L20"},"signature":["\"DISCOVER_APP_URL_GENERATOR\""],"initialIsOpen":false}],"objects":[],"setup":{"id":"def-public.DiscoverSetup","type":"Interface","label":"DiscoverSetup","description":[],"children":[{"id":"def-public.DiscoverSetup.docViews","type":"Object","label":"docViews","description":[],"source":{"path":"src/plugins/discover/public/plugin.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/plugin.ts#L75"},"signature":["{ addDocView(docViewRaw: ",{"pluginId":"discover","scope":"public","docId":"kibDiscoverPluginApi","section":"def-public.DocViewInput","text":"DocViewInput"}," | ",{"pluginId":"discover","scope":"public","docId":"kibDiscoverPluginApi","section":"def-public.DocViewInputFn","text":"DocViewInputFn"},"): void; }"]}],"source":{"path":"src/plugins/discover/public/plugin.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/plugin.ts#L74"},"lifecycle":"setup","initialIsOpen":true},"start":{"id":"def-public.DiscoverStart","type":"Interface","label":"DiscoverStart","description":[],"children":[{"id":"def-public.DiscoverStart.savedSearchLoader","type":"Object","label":"savedSearchLoader","description":[],"source":{"path":"src/plugins/discover/public/plugin.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/plugin.ts#L86"},"signature":[{"pluginId":"savedObjects","scope":"public","docId":"kibSavedObjectsPluginApi","section":"def-public.SavedObjectLoader","text":"SavedObjectLoader"}]},{"id":"def-public.DiscoverStart.urlGenerator","type":"Object","label":"urlGenerator","description":["\n`share` plugin URL generator for Discover app. Use it to generate links into\nDiscover application, example:\n\n```ts\nconst url = await plugins.discover.urlGenerator.createUrl({\n savedSearchId: '571aaf70-4c88-11e8-b3d7-01146121b73d',\n indexPatternId: 'c367b774-a4c2-11ea-bb37-0242ac130002',\n timeRange: {\n to: 'now',\n from: 'now-15m',\n mode: 'relative',\n },\n});\n```"],"source":{"path":"src/plugins/discover/public/plugin.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/plugin.ts#L104"},"signature":[{"pluginId":"share","scope":"public","docId":"kibSharePluginApi","section":"def-public.UrlGeneratorContract","text":"UrlGeneratorContract"},"<\"DISCOVER_APP_URL_GENERATOR\"> | undefined"]}],"source":{"path":"src/plugins/discover/public/plugin.ts","lineNumber":85,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/public/plugin.ts#L85"},"lifecycle":"start","initialIsOpen":true}},"server":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[{"id":"def-common.DEFAULT_COLUMNS_SETTING","type":"string","label":"DEFAULT_COLUMNS_SETTING","description":[],"source":{"path":"src/plugins/discover/common/index.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L9"},"signature":["\"defaultColumns\""],"initialIsOpen":false},{"id":"def-common.SAMPLE_SIZE_SETTING","type":"string","label":"SAMPLE_SIZE_SETTING","description":[],"source":{"path":"src/plugins/discover/common/index.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L10"},"signature":["\"discover:sampleSize\""],"initialIsOpen":false},{"id":"def-common.AGGS_TERMS_SIZE_SETTING","type":"string","label":"AGGS_TERMS_SIZE_SETTING","description":[],"source":{"path":"src/plugins/discover/common/index.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L11"},"signature":["\"discover:aggs:terms:size\""],"initialIsOpen":false},{"id":"def-common.SORT_DEFAULT_ORDER_SETTING","type":"string","label":"SORT_DEFAULT_ORDER_SETTING","description":[],"source":{"path":"src/plugins/discover/common/index.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L12"},"signature":["\"discover:sort:defaultOrder\""],"initialIsOpen":false},{"id":"def-common.SEARCH_ON_PAGE_LOAD_SETTING","type":"string","label":"SEARCH_ON_PAGE_LOAD_SETTING","description":[],"source":{"path":"src/plugins/discover/common/index.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L13"},"signature":["\"discover:searchOnPageLoad\""],"initialIsOpen":false},{"id":"def-common.DOC_HIDE_TIME_COLUMN_SETTING","type":"string","label":"DOC_HIDE_TIME_COLUMN_SETTING","description":[],"source":{"path":"src/plugins/discover/common/index.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L14"},"signature":["\"doc_table:hideTimeColumn\""],"initialIsOpen":false},{"id":"def-common.FIELDS_LIMIT_SETTING","type":"string","label":"FIELDS_LIMIT_SETTING","description":[],"source":{"path":"src/plugins/discover/common/index.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L15"},"signature":["\"fields:popularLimit\""],"initialIsOpen":false},{"id":"def-common.CONTEXT_DEFAULT_SIZE_SETTING","type":"string","label":"CONTEXT_DEFAULT_SIZE_SETTING","description":[],"source":{"path":"src/plugins/discover/common/index.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L16"},"signature":["\"context:defaultSize\""],"initialIsOpen":false},{"id":"def-common.CONTEXT_STEP_SETTING","type":"string","label":"CONTEXT_STEP_SETTING","description":[],"source":{"path":"src/plugins/discover/common/index.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L17"},"signature":["\"context:step\""],"initialIsOpen":false},{"id":"def-common.CONTEXT_TIE_BREAKER_FIELDS_SETTING","type":"string","label":"CONTEXT_TIE_BREAKER_FIELDS_SETTING","description":[],"source":{"path":"src/plugins/discover/common/index.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L18"},"signature":["\"context:tieBreakerFields\""],"initialIsOpen":false},{"id":"def-common.DOC_TABLE_LEGACY","type":"string","label":"DOC_TABLE_LEGACY","description":[],"source":{"path":"src/plugins/discover/common/index.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L19"},"signature":["\"doc_table:legacy\""],"initialIsOpen":false},{"id":"def-common.MODIFY_COLUMNS_ON_SWITCH","type":"string","label":"MODIFY_COLUMNS_ON_SWITCH","description":[],"source":{"path":"src/plugins/discover/common/index.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L20"},"signature":["\"discover:modifyColumnsOnSwitch\""],"initialIsOpen":false},{"id":"def-common.SEARCH_FIELDS_FROM_SOURCE","type":"string","label":"SEARCH_FIELDS_FROM_SOURCE","description":[],"source":{"path":"src/plugins/discover/common/index.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/discover/common/index.ts#L21"},"signature":["\"discover:searchFieldsFromSource\""],"initialIsOpen":false}],"objects":[]}} \ No newline at end of file diff --git a/api_docs/discover.mdx b/api_docs/discover.mdx new file mode 100644 index 0000000000000..007209a95d5c0 --- /dev/null +++ b/api_docs/discover.mdx @@ -0,0 +1,28 @@ +--- +id: kibDiscoverPluginApi +slug: /kibana-dev-docs/discoverPluginApi +title: discover +image: https://source.unsplash.com/400x175/?github +summary: API docs for the discover plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discover'] +--- + +import discoverObj from './discover.json'; + +## Client + +### Setup + +### Start + +### Functions + +### Interfaces + +### Consts, variables and types + +## Common + +### Consts, variables and types + diff --git a/api_docs/discover_enhanced.json b/api_docs/discover_enhanced.json new file mode 100644 index 0000000000000..ecc3e361f1039 --- /dev/null +++ b/api_docs/discover_enhanced.json @@ -0,0 +1 @@ +{"id":"discoverEnhanced","client":{"classes":[{"id":"def-public.ExploreDataContextMenuAction","type":"Class","label":"ExploreDataContextMenuAction","description":["\nThis is \"Explore underlying data\" action which appears in the context\nmenu of a dashboard panel."],"signature":[{"pluginId":"discoverEnhanced","scope":"public","docId":"kibDiscoverEnhancedPluginApi","section":"def-public.ExploreDataContextMenuAction","text":"ExploreDataContextMenuAction"}," extends ","AbstractExploreDataAction"," implements ",{"pluginId":"uiActions","scope":"public","docId":"kibUiActionsPluginApi","section":"def-public.Action","text":"Action"},""],"children":[{"id":"def-public.ExploreDataContextMenuAction.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#L37"},"signature":["\"ACTION_EXPLORE_DATA\""]},{"id":"def-public.ExploreDataContextMenuAction.type","type":"string","label":"type","description":[],"source":{"path":"x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#L39"},"signature":["\"ACTION_EXPLORE_DATA\""]},{"id":"def-public.ExploreDataContextMenuAction.order","type":"number","label":"order","description":[],"source":{"path":"x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#L41"},"signature":["200"]},{"id":"def-public.ExploreDataContextMenuAction.getUrl","type":"Function","children":[{"type":"Object","label":"context","isRequired":true,"signature":["EmbeddableQueryContext"],"description":[],"source":{"path":"x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#L43"}}],"signature":["(context: EmbeddableQueryContext) => Promise<",{"pluginId":"share","scope":"public","docId":"kibSharePluginApi","section":"def-public.KibanaURL","text":"KibanaURL"},">"],"description":[],"label":"getUrl","source":{"path":"x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#L43"},"returnComment":[]}],"source":{"path":"x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_context_menu_action.ts#L34"},"initialIsOpen":false},{"id":"def-public.ExploreDataChartAction","type":"Class","label":"ExploreDataChartAction","description":["\nThis is \"Explore underlying data\" action which appears in popup context\nmenu when user clicks a value in visualization or brushes a time range."],"signature":[{"pluginId":"discoverEnhanced","scope":"public","docId":"kibDiscoverEnhancedPluginApi","section":"def-public.ExploreDataChartAction","text":"ExploreDataChartAction"}," extends ","AbstractExploreDataAction","<","ExploreDataChartActionContext","> implements ",{"pluginId":"uiActions","scope":"public","docId":"kibUiActionsPluginApi","section":"def-public.Action","text":"Action"},"<","ExploreDataChartActionContext"],"children":[{"id":"def-public.ExploreDataChartAction.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts#L35"},"signature":["\"ACTION_EXPLORE_DATA_CHART\""]},{"id":"def-public.ExploreDataChartAction.type","type":"string","label":"type","description":[],"source":{"path":"x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts#L37"},"signature":["\"ACTION_EXPLORE_DATA_CHART\""]},{"id":"def-public.ExploreDataChartAction.order","type":"number","label":"order","description":[],"source":{"path":"x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts#L39"},"signature":["200"]},{"id":"def-public.ExploreDataChartAction.isCompatible","type":"Function","label":"isCompatible","signature":["(context: ",{"pluginId":"discoverEnhanced","scope":"public","docId":"kibDiscoverEnhancedPluginApi","section":"def-public.ExploreDataChartActionContext","text":"ExploreDataChartActionContext"},") => Promise"],"description":[],"children":[{"type":"Object","label":"context","isRequired":true,"signature":[{"pluginId":"discoverEnhanced","scope":"public","docId":"kibDiscoverEnhancedPluginApi","section":"def-public.ExploreDataChartActionContext","text":"ExploreDataChartActionContext"}],"description":[],"source":{"path":"x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts#L41"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts#L41"}},{"id":"def-public.ExploreDataChartAction.getUrl","type":"Function","children":[{"type":"Object","label":"context","isRequired":true,"signature":[{"pluginId":"discoverEnhanced","scope":"public","docId":"kibDiscoverEnhancedPluginApi","section":"def-public.ExploreDataChartActionContext","text":"ExploreDataChartActionContext"}],"description":[],"source":{"path":"x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts#L47"}}],"signature":["(context: ",{"pluginId":"discoverEnhanced","scope":"public","docId":"kibDiscoverEnhancedPluginApi","section":"def-public.ExploreDataChartActionContext","text":"ExploreDataChartActionContext"},") => Promise<",{"pluginId":"share","scope":"public","docId":"kibSharePluginApi","section":"def-public.KibanaURL","text":"KibanaURL"},">"],"description":[],"label":"getUrl","source":{"path":"x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts#L46"},"returnComment":[]}],"source":{"path":"x-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/actions/explore_data/explore_data_chart_action.ts#L32"},"initialIsOpen":false},{"id":"def-public.DiscoverEnhancedPlugin","type":"Class","label":"DiscoverEnhancedPlugin","description":[],"signature":[{"pluginId":"discoverEnhanced","scope":"public","docId":"kibDiscoverEnhancedPluginApi","section":"def-public.DiscoverEnhancedPlugin","text":"DiscoverEnhancedPlugin"}," implements ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Plugin","text":"Plugin"},""],"children":[{"id":"def-public.DiscoverEnhancedPlugin.config","type":"Object","label":"config","description":[],"source":{"path":"x-pack/plugins/discover_enhanced/public/plugin.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L43"},"signature":[{"pluginId":"discoverEnhanced","scope":"common","docId":"kibDiscoverEnhancedPluginApi","section":"def-common.Config","text":"Config"}]},{"id":"def-public.DiscoverEnhancedPlugin.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"context","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.PluginInitializerContext","text":"PluginInitializerContext"},""],"description":[],"source":{"path":"x-pack/plugins/discover_enhanced/public/plugin.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L45"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/discover_enhanced/public/plugin.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L45"}},{"id":"def-public.DiscoverEnhancedPlugin.setup","type":"Function","label":"setup","signature":["(core: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreSetup","text":"CoreSetup"},"<",{"pluginId":"discoverEnhanced","scope":"public","docId":"kibDiscoverEnhancedPluginApi","section":"def-public.DiscoverEnhancedStartDependencies","text":"DiscoverEnhancedStartDependencies"},", unknown>, { uiActions, share }: ",{"pluginId":"discoverEnhanced","scope":"public","docId":"kibDiscoverEnhancedPluginApi","section":"def-public.DiscoverEnhancedSetupDependencies","text":"DiscoverEnhancedSetupDependencies"},") => void"],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreSetup","text":"CoreSetup"},"<",{"pluginId":"discoverEnhanced","scope":"public","docId":"kibDiscoverEnhancedPluginApi","section":"def-public.DiscoverEnhancedStartDependencies","text":"DiscoverEnhancedStartDependencies"},", unknown>"],"description":[],"source":{"path":"x-pack/plugins/discover_enhanced/public/plugin.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L50"}},{"type":"Object","label":"{ uiActions, share }","isRequired":true,"signature":[{"pluginId":"discoverEnhanced","scope":"public","docId":"kibDiscoverEnhancedPluginApi","section":"def-public.DiscoverEnhancedSetupDependencies","text":"DiscoverEnhancedSetupDependencies"}],"description":[],"source":{"path":"x-pack/plugins/discover_enhanced/public/plugin.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L51"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/discover_enhanced/public/plugin.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L49"}},{"id":"def-public.DiscoverEnhancedPlugin.start","type":"Function","label":"start","signature":["(core: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreStart","text":"CoreStart"},", plugins: ",{"pluginId":"discoverEnhanced","scope":"public","docId":"kibDiscoverEnhancedPluginApi","section":"def-public.DiscoverEnhancedStartDependencies","text":"DiscoverEnhancedStartDependencies"},") => void"],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreStart","text":"CoreStart"}],"description":[],"source":{"path":"x-pack/plugins/discover_enhanced/public/plugin.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L69"}},{"type":"Object","label":"plugins","isRequired":true,"signature":[{"pluginId":"discoverEnhanced","scope":"public","docId":"kibDiscoverEnhancedPluginApi","section":"def-public.DiscoverEnhancedStartDependencies","text":"DiscoverEnhancedStartDependencies"}],"description":[],"source":{"path":"x-pack/plugins/discover_enhanced/public/plugin.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L69"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/discover_enhanced/public/plugin.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L69"}},{"id":"def-public.DiscoverEnhancedPlugin.stop","type":"Function","label":"stop","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/discover_enhanced/public/plugin.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L71"}}],"source":{"path":"x-pack/plugins/discover_enhanced/public/plugin.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L40"},"initialIsOpen":false}],"functions":[],"interfaces":[{"id":"def-public.DiscoverEnhancedSetupDependencies","type":"Interface","label":"DiscoverEnhancedSetupDependencies","description":[],"children":[{"id":"def-public.DiscoverEnhancedSetupDependencies.discover","type":"Object","label":"discover","description":[],"source":{"path":"x-pack/plugins/discover_enhanced/public/plugin.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L25"},"signature":[{"pluginId":"discover","scope":"public","docId":"kibDiscoverPluginApi","section":"def-public.DiscoverSetup","text":"DiscoverSetup"}]},{"id":"def-public.DiscoverEnhancedSetupDependencies.embeddable","type":"Object","label":"embeddable","description":[],"source":{"path":"x-pack/plugins/discover_enhanced/public/plugin.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L26"},"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableSetup","text":"EmbeddableSetup"}]},{"id":"def-public.DiscoverEnhancedSetupDependencies.kibanaLegacy","type":"Object","label":"kibanaLegacy","description":[],"source":{"path":"x-pack/plugins/discover_enhanced/public/plugin.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L27"},"signature":["{} | undefined"]},{"id":"def-public.DiscoverEnhancedSetupDependencies.share","type":"CompoundType","label":"share","description":[],"source":{"path":"x-pack/plugins/discover_enhanced/public/plugin.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L28"},"signature":[{"pluginId":"share","scope":"public","docId":"kibSharePluginApi","section":"def-public.SharePluginSetup","text":"SharePluginSetup"}," | undefined"]},{"id":"def-public.DiscoverEnhancedSetupDependencies.uiActions","type":"Object","label":"uiActions","description":[],"source":{"path":"x-pack/plugins/discover_enhanced/public/plugin.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L29"},"signature":["Pick<",{"pluginId":"uiActions","scope":"public","docId":"kibUiActionsPluginApi","section":"def-public.UiActionsService","text":"UiActionsService"},", \"addTriggerAction\" | \"attachAction\" | \"detachAction\" | \"registerAction\" | \"registerTrigger\" | \"unregisterAction\">"]}],"source":{"path":"x-pack/plugins/discover_enhanced/public/plugin.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L24"},"initialIsOpen":false},{"id":"def-public.DiscoverEnhancedStartDependencies","type":"Interface","label":"DiscoverEnhancedStartDependencies","description":[],"children":[{"id":"def-public.DiscoverEnhancedStartDependencies.discover","type":"Object","label":"discover","description":[],"source":{"path":"x-pack/plugins/discover_enhanced/public/plugin.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L33"},"signature":[{"pluginId":"discover","scope":"public","docId":"kibDiscoverPluginApi","section":"def-public.DiscoverStart","text":"DiscoverStart"}]},{"id":"def-public.DiscoverEnhancedStartDependencies.embeddable","type":"Object","label":"embeddable","description":[],"source":{"path":"x-pack/plugins/discover_enhanced/public/plugin.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L34"},"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableStart","text":"EmbeddableStart"}]},{"id":"def-public.DiscoverEnhancedStartDependencies.kibanaLegacy","type":"Object","label":"kibanaLegacy","description":[],"source":{"path":"x-pack/plugins/discover_enhanced/public/plugin.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L35"},"signature":["{ dashboardConfig: ",{"pluginId":"kibanaLegacy","scope":"public","docId":"kibKibanaLegacyPluginApi","section":"def-public.DashboardConfig","text":"DashboardConfig"},"; loadFontAwesome: () => Promise; config: Readonly<{} & { defaultAppId: string; }>; } | undefined"]},{"id":"def-public.DiscoverEnhancedStartDependencies.share","type":"CompoundType","label":"share","description":[],"source":{"path":"x-pack/plugins/discover_enhanced/public/plugin.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L36"},"signature":[{"pluginId":"share","scope":"public","docId":"kibSharePluginApi","section":"def-public.SharePluginStart","text":"SharePluginStart"}," | undefined"]},{"id":"def-public.DiscoverEnhancedStartDependencies.uiActions","type":"Object","label":"uiActions","description":[],"source":{"path":"x-pack/plugins/discover_enhanced/public/plugin.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L37"},"signature":["Pick<",{"pluginId":"uiActions","scope":"public","docId":"kibUiActionsPluginApi","section":"def-public.UiActionsService","text":"UiActionsService"},", ","MethodKeysOf","<",{"pluginId":"uiActions","scope":"public","docId":"kibUiActionsPluginApi","section":"def-public.UiActionsService","text":"UiActionsService"},">>"]}],"source":{"path":"x-pack/plugins/discover_enhanced/public/plugin.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/public/plugin.ts#L32"},"initialIsOpen":false}],"enums":[],"misc":[],"objects":[]},"server":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"common":{"classes":[],"functions":[],"interfaces":[{"id":"def-common.Config","type":"Interface","label":"Config","description":[],"children":[{"id":"def-common.Config.actions","type":"Object","label":"actions","description":[],"source":{"path":"x-pack/plugins/discover_enhanced/common/config.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/common/config.ts#L9"},"signature":["{ exploreDataInChart: { enabled: boolean; }; }"]}],"source":{"path":"x-pack/plugins/discover_enhanced/common/config.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/discover_enhanced/common/config.ts#L8"},"initialIsOpen":false}],"enums":[],"misc":[],"objects":[]}} \ No newline at end of file diff --git a/api_docs/discover_enhanced.mdx b/api_docs/discover_enhanced.mdx new file mode 100644 index 0000000000000..0b88a8a165bcf --- /dev/null +++ b/api_docs/discover_enhanced.mdx @@ -0,0 +1,22 @@ +--- +id: kibDiscoverEnhancedPluginApi +slug: /kibana-dev-docs/discoverEnhancedPluginApi +title: discoverEnhanced +image: https://source.unsplash.com/400x175/?github +summary: API docs for the discoverEnhanced plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'discoverEnhanced'] +--- + +import discoverEnhancedObj from './discover_enhanced.json'; + +## Client + +### Classes + +### Interfaces + +## Common + +### Interfaces + diff --git a/api_docs/embeddable.json b/api_docs/embeddable.json new file mode 100644 index 0000000000000..babec35f3c435 --- /dev/null +++ b/api_docs/embeddable.json @@ -0,0 +1 @@ +{"id":"embeddable","client":{"classes":[{"id":"def-public.AddPanelAction","type":"Class","label":"AddPanelAction","description":[],"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.AddPanelAction","text":"AddPanelAction"}," implements ",{"pluginId":"uiActions","scope":"public","docId":"kibUiActionsPluginApi","section":"def-public.Action","text":"Action"},""],"children":[{"id":"def-public.AddPanelAction.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L24"},"signature":["\"ACTION_ADD_PANEL\""]},{"id":"def-public.AddPanelAction.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L25"},"signature":["\"ACTION_ADD_PANEL\""]},{"id":"def-public.AddPanelAction.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Function","label":"getFactory","isRequired":true,"signature":[" IterableIterator<",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableFactory","text":"EmbeddableFactory"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"},", ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableOutput","text":"EmbeddableOutput"},", ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IEmbeddable","text":"IEmbeddable"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"}],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L29"}},{"type":"Object","label":"overlays","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.OverlayStart","text":"OverlayStart"}],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L30"}},{"type":"Object","label":"notifications","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.NotificationsStart","text":"NotificationsStart"}],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L31"}},{"type":"CompoundType","label":"SavedObjectFinder","isRequired":true,"signature":["React.ComponentType"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L32"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L27"}},{"id":"def-public.AddPanelAction.getDisplayName","type":"Function","label":"getDisplayName","signature":["() => string"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L35"}},{"id":"def-public.AddPanelAction.getIconType","type":"Function","label":"getIconType","signature":["() => string"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L41"}},{"id":"def-public.AddPanelAction.isCompatible","type":"Function","label":"isCompatible","signature":["(context: ",{"pluginId":"uiActions","scope":"public","docId":"kibUiActionsPluginApi","section":"def-public.ActionExecutionContext","text":"ActionExecutionContext"},") => Promise"],"description":[],"children":[{"type":"CompoundType","label":"context","isRequired":true,"signature":[{"pluginId":"uiActions","scope":"public","docId":"kibUiActionsPluginApi","section":"def-public.ActionExecutionContext","text":"ActionExecutionContext"},""],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L45"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L45"}},{"id":"def-public.AddPanelAction.execute","type":"Function","label":"execute","signature":["(context: ",{"pluginId":"uiActions","scope":"public","docId":"kibUiActionsPluginApi","section":"def-public.ActionExecutionContext","text":"ActionExecutionContext"},") => Promise"],"description":[],"children":[{"type":"CompoundType","label":"context","isRequired":true,"signature":[{"pluginId":"uiActions","scope":"public","docId":"kibUiActionsPluginApi","section":"def-public.ActionExecutionContext","text":"ActionExecutionContext"},""],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L50"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L50"}}],"source":{"path":"src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L23"},"initialIsOpen":false},{"id":"def-public.Container","type":"Class","label":"Container","description":[],"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.Container","text":"Container"}," extends ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.Embeddable","text":"Embeddable"}," implements ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IContainer","text":"IContainer"},""],"children":[{"id":"def-public.Container.isContainer","type":"boolean","label":"isContainer","description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/container.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L34"}},{"id":"def-public.Container.children","type":"Object","children":[],"description":[],"label":"children","source":{"path":"src/plugins/embeddable/public/lib/containers/container.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L35"}},{"id":"def-public.Container.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Uncategorized","label":"input","isRequired":true,"signature":["TContainerInput"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/container.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L42"}},{"type":"Uncategorized","label":"output","isRequired":true,"signature":["TContainerOutput"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/container.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L43"}},{"type":"Function","label":"getFactory","isRequired":true,"signature":[", ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerOutput","text":"ContainerOutput"},"> | undefined"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/container.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L45"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/container.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L41"}},{"id":"def-public.Container.updateInputForChild","type":"Function","label":"updateInputForChild","signature":["(id: string, changes: Partial) => void"],"description":[],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/container.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L57"}},{"type":"Object","label":"changes","isRequired":true,"signature":["Partial"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/container.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L58"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/container.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L56"}},{"id":"def-public.Container.reload","type":"Function","label":"reload","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/container.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L78"}},{"id":"def-public.Container.addNewEmbeddable","type":"Function","label":"addNewEmbeddable","signature":[""],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/container.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L86"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/container.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L82"}},{"id":"def-public.Container.removeEmbeddable","type":"Function","label":"removeEmbeddable","signature":["(embeddableId: string) => void"],"description":[],"children":[{"type":"string","label":"embeddableId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/container.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L98"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/container.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L98"}},{"id":"def-public.Container.getChildIds","type":"Function","label":"getChildIds","signature":["() => string[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/container.ts","lineNumber":106,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L106"}},{"id":"def-public.Container.getChild","type":"Function","label":"getChild","signature":[">(id: string) => E"],"description":[],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/container.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L110"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/container.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L110"}},{"id":"def-public.Container.getInputForChild","type":"Function","label":"getInputForChild","signature":["(embeddableId: string) => TEmbeddableInput"],"description":[],"children":[{"type":"string","label":"embeddableId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/container.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L115"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/container.ts","lineNumber":114,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L114"}},{"id":"def-public.Container.destroy","type":"Function","label":"destroy","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/container.ts","lineNumber":146,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L146"}},{"id":"def-public.Container.untilEmbeddableLoaded","type":"Function","label":"untilEmbeddableLoaded","signature":[">(id: string) => Promise<",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ErrorEmbeddable","text":"ErrorEmbeddable"}," | TEmbeddable>"],"description":[],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/container.ts","lineNumber":153,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L153"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/container.ts","lineNumber":152,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L152"}},{"id":"def-public.Container.createNewPanelState","type":"Function","label":"createNewPanelState","signature":[">(factory: ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableFactory","text":"EmbeddableFactory"},", partial?: Partial) => ",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.PanelState","text":"PanelState"}],"description":[],"children":[{"type":"Object","label":"factory","isRequired":true,"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableFactory","text":"EmbeddableFactory"},""],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/container.ts","lineNumber":184,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L184"}},{"type":"Object","label":"partial","isRequired":true,"signature":["Partial"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/container.ts","lineNumber":185,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L185"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/container.ts","lineNumber":180,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L180"}},{"id":"def-public.Container.getPanelState","type":"Function","label":"getPanelState","signature":["(embeddableId: string) => ",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.PanelState","text":"PanelState"},""],"description":[],"children":[{"type":"string","label":"embeddableId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/container.ts","lineNumber":205,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L205"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/container.ts","lineNumber":204,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L204"}},{"id":"def-public.Container.getInheritedInput","type":"Function","label":"getInheritedInput","signature":["(id: string) => TChildInput"],"description":["\nReturn state that comes from the container and is passed down to the child. For instance, time range and\nfilters are common inherited input state. Note that any state stored in `this.input.panels[embeddableId].explicitInput`\nwill override inherited input."],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/container.ts","lineNumber":219,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L219"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/container.ts","lineNumber":219,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L219"}}],"source":{"path":"src/plugins/embeddable/public/lib/containers/container.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/container.ts#L27"},"initialIsOpen":false},{"id":"def-public.EditPanelAction","type":"Class","label":"EditPanelAction","description":[],"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EditPanelAction","text":"EditPanelAction"}," implements ",{"pluginId":"uiActions","scope":"public","docId":"kibUiActionsPluginApi","section":"def-public.Action","text":"Action"},""],"children":[{"id":"def-public.EditPanelAction.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/embeddable/public/lib/actions/edit_panel_action.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L38"},"signature":["\"editPanel\""]},{"id":"def-public.EditPanelAction.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/embeddable/public/lib/actions/edit_panel_action.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L39"},"signature":["\"editPanel\""]},{"id":"def-public.EditPanelAction.order","type":"number","label":"order","description":[],"source":{"path":"src/plugins/embeddable/public/lib/actions/edit_panel_action.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L40"}},{"id":"def-public.EditPanelAction.currentAppId","type":"string","label":"currentAppId","description":[],"source":{"path":"src/plugins/embeddable/public/lib/actions/edit_panel_action.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L41"},"signature":["string | undefined"]},{"id":"def-public.EditPanelAction.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Function","label":"getEmbeddableFactory","isRequired":true,"signature":[" string"],"description":[],"children":[{"type":"Object","label":"{ embeddable }","isRequired":true,"signature":["ActionContext"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/actions/edit_panel_action.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L55"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/actions/edit_panel_action.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L55"}},{"id":"def-public.EditPanelAction.getIconType","type":"Function","label":"getIconType","signature":["() => string"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/actions/edit_panel_action.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L68"}},{"id":"def-public.EditPanelAction.isCompatible","type":"Function","label":"isCompatible","signature":["({ embeddable }: ActionContext) => Promise"],"description":[],"children":[{"type":"Object","label":"{ embeddable }","isRequired":true,"signature":["ActionContext"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/actions/edit_panel_action.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L72"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/actions/edit_panel_action.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L72"}},{"id":"def-public.EditPanelAction.execute","type":"Function","label":"execute","signature":["(context: ActionContext) => Promise"],"description":[],"children":[{"type":"Object","label":"context","isRequired":true,"signature":["ActionContext"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/actions/edit_panel_action.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L83"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/actions/edit_panel_action.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L83"}},{"id":"def-public.EditPanelAction.getAppTarget","type":"Function","label":"getAppTarget","signature":["({ embeddable }: ActionContext) => NavigationContext | undefined"],"description":[],"children":[{"type":"Object","label":"{ embeddable }","isRequired":true,"signature":["ActionContext"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/actions/edit_panel_action.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L104"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/actions/edit_panel_action.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L104"}},{"id":"def-public.EditPanelAction.getHref","type":"Function","label":"getHref","signature":["({ embeddable }: ActionContext) => Promise"],"description":[],"children":[{"type":"Object","label":"{ embeddable }","isRequired":true,"signature":["ActionContext"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/actions/edit_panel_action.ts","lineNumber":121,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L121"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/actions/edit_panel_action.ts","lineNumber":121,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L121"}}],"source":{"path":"src/plugins/embeddable/public/lib/actions/edit_panel_action.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L37"},"initialIsOpen":false},{"id":"def-public.Embeddable","type":"Class","label":"Embeddable","description":[],"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.Embeddable","text":"Embeddable"}," implements ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IEmbeddable","text":"IEmbeddable"},""],"children":[{"id":"def-public.Embeddable.runtimeId","type":"number","label":"runtimeId","description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L27"}},{"id":"def-public.Embeddable.runtimeId","type":"number","label":"runtimeId","description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L29"}},{"id":"def-public.Embeddable.parent","type":"Object","label":"parent","description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L31"},"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IContainer","text":"IContainer"},"<{}, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerInput","text":"ContainerInput"},"<{}>, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerOutput","text":"ContainerOutput"},"> | undefined"]},{"id":"def-public.Embeddable.isContainer","type":"boolean","label":"isContainer","description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L32"}},{"id":"def-public.Embeddable.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L33"}},{"id":"def-public.Embeddable.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L34"}},{"id":"def-public.Embeddable.fatalError","type":"Object","label":"fatalError","description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L35"},"signature":["Error | undefined"]},{"id":"def-public.Embeddable.output","type":"Uncategorized","label":"output","description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L37"},"signature":["TEmbeddableOutput"]},{"id":"def-public.Embeddable.input","type":"Uncategorized","label":"input","description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L38"},"signature":["TEmbeddableInput"]},{"id":"def-public.Embeddable.renderComplete","type":"Object","label":"renderComplete","description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L43"},"signature":[{"pluginId":"kibanaUtils","scope":"public","docId":"kibKibanaUtilsPluginApi","section":"def-public.RenderCompleteDispatcher","text":"RenderCompleteDispatcher"}]},{"id":"def-public.Embeddable.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Uncategorized","label":"input","isRequired":true,"signature":["TEmbeddableInput"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L51"}},{"type":"Uncategorized","label":"output","isRequired":true,"signature":["TEmbeddableOutput"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L51"}},{"type":"Object","label":"parent","isRequired":false,"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IContainer","text":"IContainer"},"<{}, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerInput","text":"ContainerInput"},"<{}>, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerOutput","text":"ContainerOutput"},"> | undefined"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L51"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L51"}},{"id":"def-public.Embeddable.getIsContainer","type":"Function","label":"getIsContainer","signature":["() => this is ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IContainer","text":"IContainer"},"<{}, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerInput","text":"ContainerInput"},"<{}>, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerOutput","text":"ContainerOutput"},">"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L89"}},{"id":"def-public.Embeddable.reload","type":"Function","label":"reload","signature":["() => void"],"description":["\nReload will be called when there is a request to refresh the data or view, even if the\ninput data did not change.\n\nIn case if input data did change and reload is requested input$ and output$ would still emit before `reload` is called\n\nThe order would be as follows:\ninput$\noutput$\nreload()\n----\nupdated$"],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":106,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L106"}},{"id":"def-public.Embeddable.getUpdated$","type":"Function","label":"getUpdated$","signature":["() => Readonly<","Observable",">"],"description":["\nMerges input$ and output$ streams and debounces emit till next macro-task.\nCould be useful to batch reactions to input$ and output$ updates that happen separately but synchronously.\nIn case corresponding state change triggered `reload` this stream is guarantied to emit later,\nwhich allows to skip any state handling in case `reload` already handled it."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":114,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L114"}},{"id":"def-public.Embeddable.getInput$","type":"Function","label":"getInput$","signature":["() => Readonly<","Observable",">"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":121,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L121"}},{"id":"def-public.Embeddable.getOutput$","type":"Function","label":"getOutput$","signature":["() => Readonly<","Observable",">"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":125,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L125"}},{"id":"def-public.Embeddable.getOutput","type":"Function","label":"getOutput","signature":["() => Readonly"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":129,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L129"}},{"id":"def-public.Embeddable.getInput","type":"Function","label":"getInput","signature":["() => Readonly"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":133,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L133"}},{"id":"def-public.Embeddable.getTitle","type":"Function","label":"getTitle","signature":["() => string"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":137,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L137"}},{"id":"def-public.Embeddable.getRoot","type":"Function","label":"getRoot","signature":["() => ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IEmbeddable","text":"IEmbeddable"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"},", ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableOutput","text":"EmbeddableOutput"},"> | ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IContainer","text":"IContainer"},"<{}, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerInput","text":"ContainerInput"}],"description":["\nReturns the top most parent embeddable, or itself if this embeddable\nis not within a parent."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":145,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L145"}},{"id":"def-public.Embeddable.updateInput","type":"Function","label":"updateInput","signature":["(changes: Partial) => void"],"description":[],"children":[{"type":"Object","label":"changes","isRequired":true,"signature":["Partial"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":153,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L153"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":153,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L153"}},{"id":"def-public.Embeddable.render","type":"Function","label":"render","signature":["(el: HTMLElement) => void"],"description":[],"children":[{"type":"Object","label":"el","isRequired":true,"signature":["HTMLElement"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":165,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L165"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":165,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L165"}},{"id":"def-public.Embeddable.getInspectorAdapters","type":"Function","label":"getInspectorAdapters","signature":["() => ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"}," | undefined"],"description":["\nAn embeddable can return inspector adapters if it want the inspector to be\navailable via the context menu of that panel."],"children":[],"tags":["return"],"returnComment":["Inspector adapters that will be used to open an inspector for."],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":180,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L180"}},{"id":"def-public.Embeddable.destroy","type":"Function","label":"destroy","signature":["() => void"],"description":["\nCalled when this embeddable is no longer used, this should be the place for\nimplementors to add any additional clean up tasks, like unmounting and unsubscribing."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":188,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L188"}},{"id":"def-public.Embeddable.updateOutput","type":"Function","label":"updateOutput","signature":["(outputChanges: Partial) => void"],"description":[],"children":[{"type":"Object","label":"outputChanges","isRequired":true,"signature":["Partial"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":200,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L200"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":200,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L200"}},{"id":"def-public.Embeddable.onFatalError","type":"Function","label":"onFatalError","signature":["(e: Error) => void"],"description":[],"children":[{"type":"Object","label":"e","isRequired":true,"signature":["Error"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":211,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L211"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":211,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L211"}},{"id":"def-public.Embeddable.supportedTriggers","type":"Function","label":"supportedTriggers","signature":["() => string[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":239,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L239"}}],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable.tsx","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable.tsx#L23"},"initialIsOpen":false},{"id":"def-public.EmbeddableChildPanel","type":"Class","label":"EmbeddableChildPanel","description":["\nThis component can be used by embeddable containers using react to easily render children. It waits\nfor the child to be initialized, showing a loading indicator until that is complete."],"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableChildPanel","text":"EmbeddableChildPanel"}," extends React.Component<",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableChildPanelProps","text":"EmbeddableChildPanelProps"},", State, any>"],"children":[{"id":"def-public.EmbeddableChildPanel.mounted","type":"boolean","label":"mounted","description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx#L36"}},{"id":"def-public.EmbeddableChildPanel.embeddable","type":"CompoundType","label":"embeddable","description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx#L37"},"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IEmbeddable","text":"IEmbeddable"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"},", ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableOutput","text":"EmbeddableOutput"},"> | ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ErrorEmbeddable","text":"ErrorEmbeddable"}]},{"id":"def-public.EmbeddableChildPanel.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"props","isRequired":true,"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableChildPanelProps","text":"EmbeddableChildPanelProps"}],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx#L40"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx#L40"}},{"id":"def-public.EmbeddableChildPanel.componentDidMount","type":"Function","label":"componentDidMount","signature":["() => Promise"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx#L49"}},{"id":"def-public.EmbeddableChildPanel.componentWillUnmount","type":"Function","label":"componentWillUnmount","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx#L59"}},{"id":"def-public.EmbeddableChildPanel.render","type":"Function","label":"render","signature":["() => JSX.Element"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx#L66"}}],"source":{"path":"src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx#L34"},"initialIsOpen":false},{"id":"def-public.EmbeddableFactoryNotFoundError","type":"Class","label":"EmbeddableFactoryNotFoundError","description":[],"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableFactoryNotFoundError","text":"EmbeddableFactoryNotFoundError"}," extends Error"],"children":[{"id":"def-public.EmbeddableFactoryNotFoundError.code","type":"string","label":"code","description":[],"source":{"path":"src/plugins/embeddable/public/lib/errors.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/errors.ts#L25"}},{"id":"def-public.EmbeddableFactoryNotFoundError.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/errors.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/errors.ts#L27"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/errors.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/errors.ts#L27"}}],"source":{"path":"src/plugins/embeddable/public/lib/errors.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/errors.ts#L24"},"initialIsOpen":false},{"id":"def-public.EmbeddablePanel","type":"Class","label":"EmbeddablePanel","description":[],"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddablePanel","text":"EmbeddablePanel"}," extends React.Component"],"children":[{"id":"def-public.EmbeddablePanel.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"props","isRequired":true,"signature":["Props"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/embeddable_panel.tsx#L96"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/embeddable_panel.tsx#L96"}},{"id":"def-public.EmbeddablePanel.UNSAFE_componentWillMount","type":"Function","label":"UNSAFE_componentWillMount","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx","lineNumber":153,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/embeddable_panel.tsx#L153"}},{"id":"def-public.EmbeddablePanel.componentWillUnmount","type":"Function","label":"componentWillUnmount","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx","lineNumber":187,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/embeddable_panel.tsx#L187"}},{"id":"def-public.EmbeddablePanel.onFocus","type":"Function","children":[{"type":"string","label":"focusedPanelIndex","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx","lineNumber":199,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/embeddable_panel.tsx#L199"}}],"signature":["(focusedPanelIndex: string) => void"],"description":[],"label":"onFocus","source":{"path":"src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx","lineNumber":199,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/embeddable_panel.tsx#L199"},"returnComment":[]},{"id":"def-public.EmbeddablePanel.onBlur","type":"Function","children":[{"type":"string","label":"blurredPanelIndex","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx","lineNumber":203,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/embeddable_panel.tsx#L203"}}],"signature":["(blurredPanelIndex: string) => void"],"description":[],"label":"onBlur","source":{"path":"src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx","lineNumber":203,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/embeddable_panel.tsx#L203"},"returnComment":[]},{"id":"def-public.EmbeddablePanel.render","type":"Function","label":"render","signature":["() => JSX.Element"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx","lineNumber":209,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/embeddable_panel.tsx#L209"}},{"id":"def-public.EmbeddablePanel.componentDidMount","type":"Function","label":"componentDidMount","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx","lineNumber":251,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/embeddable_panel.tsx#L251"}},{"id":"def-public.EmbeddablePanel.closeMyContextMenuPanel","type":"Function","children":[],"signature":["() => void"],"description":[],"label":"closeMyContextMenuPanel","source":{"path":"src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx","lineNumber":274,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/embeddable_panel.tsx#L274"},"returnComment":[]}],"source":{"path":"src/plugins/embeddable/public/lib/panel/embeddable_panel.tsx","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/embeddable_panel.tsx#L89"},"initialIsOpen":false},{"id":"def-public.EmbeddableRoot","type":"Class","label":"EmbeddableRoot","description":[],"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableRoot","text":"EmbeddableRoot"}," extends React.Component"],"children":[{"id":"def-public.EmbeddableRoot.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"props","isRequired":true,"signature":["Props"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx#L25"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx#L25"}},{"id":"def-public.EmbeddableRoot.componentDidMount","type":"Function","label":"componentDidMount","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx#L31"}},{"id":"def-public.EmbeddableRoot.componentDidUpdate","type":"Function","label":"componentDidUpdate","signature":["(prevProps?: Props | undefined) => void"],"description":[],"children":[{"type":"Object","label":"prevProps","isRequired":false,"signature":["Props | undefined"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx#L38"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx#L38"}},{"id":"def-public.EmbeddableRoot.shouldComponentUpdate","type":"Function","label":"shouldComponentUpdate","signature":["(newProps: Props) => boolean"],"description":[],"children":[{"type":"Object","label":"newProps","isRequired":true,"signature":["Props"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx#L59"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx#L59"}},{"id":"def-public.EmbeddableRoot.render","type":"Function","label":"render","signature":["() => JSX.Element"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx#L69"}}],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_root.tsx#L21"},"initialIsOpen":false},{"id":"def-public.ErrorEmbeddable","type":"Class","label":"ErrorEmbeddable","description":[],"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ErrorEmbeddable","text":"ErrorEmbeddable"}," extends ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.Embeddable","text":"Embeddable"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"},", ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableOutput","text":"EmbeddableOutput"},">"],"children":[{"id":"def-public.ErrorEmbeddable.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx#L26"},"signature":["\"error\""]},{"id":"def-public.ErrorEmbeddable.error","type":"CompoundType","label":"error","description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx#L27"},"signature":["string | Error"]},{"id":"def-public.ErrorEmbeddable.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"CompoundType","label":"error","isRequired":true,"signature":["string | Error"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx#L30"}},{"type":"Object","label":"input","isRequired":true,"signature":[{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"}],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx#L30"}},{"type":"Object","label":"parent","isRequired":false,"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IContainer","text":"IContainer"},"<{}, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerInput","text":"ContainerInput"},"<{}>, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerOutput","text":"ContainerOutput"},"> | undefined"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx#L30"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx#L30"}},{"id":"def-public.ErrorEmbeddable.reload","type":"Function","label":"reload","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx#L35"}},{"id":"def-public.ErrorEmbeddable.render","type":"Function","label":"render","signature":["(dom: HTMLElement) => void"],"description":[],"children":[{"type":"Object","label":"dom","isRequired":true,"signature":["HTMLElement"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx#L37"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx#L37"}},{"id":"def-public.ErrorEmbeddable.destroy","type":"Function","label":"destroy","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx#L57"}}],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx#L25"},"initialIsOpen":false},{"id":"def-public.PanelNotFoundError","type":"Class","label":"PanelNotFoundError","description":[],"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.PanelNotFoundError","text":"PanelNotFoundError"}," extends Error"],"children":[{"id":"def-public.PanelNotFoundError.code","type":"string","label":"code","description":[],"source":{"path":"src/plugins/embeddable/public/lib/errors.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/errors.ts#L13"}},{"id":"def-public.PanelNotFoundError.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/errors.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/errors.ts#L15"}}],"source":{"path":"src/plugins/embeddable/public/lib/errors.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/errors.ts#L12"},"initialIsOpen":false},{"id":"def-public.EmbeddableStateTransfer","type":"Class","label":"EmbeddableStateTransfer","description":["\nA wrapper around the session storage which provides strongly typed helper methods\nfor common incoming and outgoing states used by the embeddable infrastructure.\n"],"children":[{"id":"def-public.EmbeddableStateTransfer.isTransferInProgress","type":"boolean","label":"isTransferInProgress","description":[],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L30"}},{"id":"def-public.EmbeddableStateTransfer.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Function","label":"navigateToApp","isRequired":true,"signature":["(appId: string, options?: ",{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.NavigateToAppOptions","text":"NavigateToAppOptions"}," | undefined) => Promise"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L34"}},{"type":"Object","label":"currentAppId$","isRequired":true,"signature":["Observable",""],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L35"}},{"type":"Object","label":"appList","isRequired":false,"signature":["ReadonlyMap | undefined"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L36"}},{"type":"Object","label":"customStorage","isRequired":false,"signature":[{"pluginId":"kibanaUtils","scope":"public","docId":"kibKibanaUtilsPluginApi","section":"def-public.Storage","text":"Storage"}," | undefined"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L37"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L33"}},{"id":"def-public.EmbeddableStateTransfer.getAppNameFromId","type":"Function","children":[{"type":"string","label":"appId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L50"}}],"signature":["(appId: string) => string | undefined"],"description":["\nFetches an internationalized app title when given an appId."],"label":"getAppNameFromId","source":{"path":"src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L50"},"returnComment":[]},{"id":"def-public.EmbeddableStateTransfer.getIncomingEditorState","type":"Function","label":"getIncomingEditorState","signature":["(appId: string, removeAfterFetch?: boolean | undefined) => ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableEditorState","text":"EmbeddableEditorState"}," | undefined"],"description":["\nFetches an {@link EmbeddableEditorState | editor state} from the sessionStorage for the provided app id\n"],"children":[{"type":"string","label":"appId","isRequired":true,"signature":["string"],"description":["- The app to fetch incomingEditorState for"],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L59"}},{"type":"CompoundType","label":"removeAfterFetch","isRequired":false,"signature":["boolean | undefined"],"description":["- Whether to remove the package state after fetch to prevent duplicates."],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L60"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L58"}},{"id":"def-public.EmbeddableStateTransfer.clearEditorState","type":"Function","label":"clearEditorState","signature":["(appId?: string | undefined) => void"],"description":["\nClears the {@link EmbeddableEditorState | editor state} from the sessionStorage for the provided app id\n"],"children":[{"type":"string","label":"appId","isRequired":false,"signature":["string | undefined"],"description":["- The app to fetch incomingEditorState for"],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L78"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L78"}},{"id":"def-public.EmbeddableStateTransfer.getIncomingEmbeddablePackage","type":"Function","label":"getIncomingEmbeddablePackage","signature":["(appId: string, removeAfterFetch?: boolean | undefined) => ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddablePackageState","text":"EmbeddablePackageState"}," | undefined"],"description":["\nFetches an {@link EmbeddablePackageState | embeddable package} from the sessionStorage for the given AppId\n"],"children":[{"type":"string","label":"appId","isRequired":true,"signature":["string"],"description":["- The app to fetch EmbeddablePackageState for"],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L97"}},{"type":"CompoundType","label":"removeAfterFetch","isRequired":false,"signature":["boolean | undefined"],"description":["- Whether to remove the package state after fetch to prevent duplicates."],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L98"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L96"}},{"id":"def-public.EmbeddableStateTransfer.navigateToEditor","type":"Function","label":"navigateToEditor","signature":["(appId: string, options?: { path?: string | undefined; state: ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableEditorState","text":"EmbeddableEditorState"},"; } | undefined) => Promise"],"description":["\nA wrapper around the {@link ApplicationStart.navigateToApp} method which navigates to the specified appId\nwith {@link EmbeddableEditorState | embeddable editor state}"],"children":[{"type":"string","label":"appId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L115"}},{"id":"def-public.EmbeddableStateTransfer.navigateToEditor.options","type":"Object","label":"options","description":[],"children":[{"id":"def-public.EmbeddableStateTransfer.navigateToEditor.options.path","type":"string","label":"path","description":[],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts","lineNumber":117,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L117"},"signature":["string | undefined"]},{"id":"def-public.EmbeddableStateTransfer.navigateToEditor.options.state","type":"Object","label":"state","description":[],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts","lineNumber":118,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L118"},"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableEditorState","text":"EmbeddableEditorState"}]}],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L116"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts","lineNumber":114,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L114"}},{"id":"def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage","type":"Function","label":"navigateToWithEmbeddablePackage","signature":["(appId: string, options?: { path?: string | undefined; state: ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddablePackageState","text":"EmbeddablePackageState"},"; } | undefined) => Promise"],"description":["\nA wrapper around the {@link ApplicationStart.navigateToApp} method which navigates to the specified appId\nwith {@link EmbeddablePackageState | embeddable package state}"],"children":[{"type":"string","label":"appId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts","lineNumber":132,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L132"}},{"id":"def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.options","type":"Object","label":"options","description":[],"children":[{"id":"def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.options.path","type":"string","label":"path","description":[],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts","lineNumber":133,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L133"},"signature":["string | undefined"]},{"id":"def-public.EmbeddableStateTransfer.navigateToWithEmbeddablePackage.options.state","type":"Object","label":"state","description":[],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts","lineNumber":133,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L133"},"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddablePackageState","text":"EmbeddablePackageState"}]}],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts","lineNumber":133,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L133"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L131"}}],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/embeddable_state_transfer.ts#L29"},"initialIsOpen":false},{"id":"def-public.AttributeService","type":"Class","label":"AttributeService","description":[],"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.AttributeService","text":"AttributeService"},""],"children":[{"id":"def-public.AttributeService.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L49"}},{"type":"Function","label":"showSaveModal","isRequired":true,"signature":["(saveModal: React.ReactElement React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>, I18nContext: ({ children }: { children: React.ReactNode; }) => JSX.Element) => void"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L50"}},{"type":"Function","label":"i18nContext","isRequired":true,"signature":["({ children }: { children: React.ReactNode; }) => JSX.Element"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L54"}},{"type":"Object","label":"toasts","isRequired":true,"signature":["Pick<",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastsApi","text":"ToastsApi"},", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L55"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.AttributeServiceOptions","text":"AttributeServiceOptions"},""],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L56"}},{"type":"Function","label":"getEmbeddableFactory","isRequired":false,"signature":["((embeddableFactoryId: string) => ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableFactory","text":"EmbeddableFactory"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"},", ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableOutput","text":"EmbeddableOutput"},", ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IEmbeddable","text":"IEmbeddable"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"}],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L57"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L48"}},{"id":"def-public.AttributeService.unwrapAttributes","type":"Function","label":"unwrapAttributes","signature":["(input: ValType | RefType) => Promise"],"description":[],"children":[{"type":"CompoundType","label":"input","isRequired":true,"signature":["ValType | RefType"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L74"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L74"}},{"id":"def-public.AttributeService.wrapAttributes","type":"Function","label":"wrapAttributes","signature":["(newAttributes: SavedObjectAttributes, useRefType: boolean, input?: ValType | RefType | undefined) => Promise>>"],"description":[],"children":[{"type":"Uncategorized","label":"newAttributes","isRequired":true,"signature":["SavedObjectAttributes"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L84"}},{"type":"boolean","label":"useRefType","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx","lineNumber":85,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L85"}},{"type":"CompoundType","label":"input","isRequired":false,"signature":["ValType | RefType | undefined"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L86"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L83"}},{"id":"def-public.AttributeService.inputIsRefType","type":"Function","children":[{"type":"CompoundType","label":"input","isRequired":true,"signature":["ValType | RefType"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L116"}}],"signature":["(input: ValType | RefType) => input is RefType"],"description":[],"label":"inputIsRefType","source":{"path":"src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L116"},"returnComment":[]},{"id":"def-public.AttributeService.getExplicitInputFromEmbeddable","type":"Function","label":"getExplicitInputFromEmbeddable","signature":["(embeddable: ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IEmbeddable","text":"IEmbeddable"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"},", ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableOutput","text":"EmbeddableOutput"},">) => ValType | RefType"],"description":[],"children":[{"type":"Object","label":"embeddable","isRequired":true,"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IEmbeddable","text":"IEmbeddable"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"},", ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableOutput","text":"EmbeddableOutput"},">"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx","lineNumber":120,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L120"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx","lineNumber":120,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L120"}},{"id":"def-public.AttributeService.getInputAsValueType","type":"Function","children":[{"type":"CompoundType","label":"input","isRequired":true,"signature":["ValType | RefType"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx","lineNumber":125,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L125"}}],"signature":["(input: ValType | RefType) => Promise"],"description":[],"label":"getInputAsValueType","source":{"path":"src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx","lineNumber":125,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L125"},"returnComment":[]},{"id":"def-public.AttributeService.getInputAsRefType","type":"Function","children":[{"type":"CompoundType","label":"input","isRequired":true,"signature":["ValType | RefType"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx","lineNumber":138,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L138"}},{"type":"CompoundType","label":"saveOptions","isRequired":false,"signature":["{ showSaveModal: boolean; saveModalTitle?: string | undefined; } | { title: string; } | undefined"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx","lineNumber":139,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L139"}}],"signature":["(input: ValType | RefType, saveOptions?: { showSaveModal: boolean; saveModalTitle?: string | undefined; } | { title: string; } | undefined) => Promise"],"description":[],"label":"getInputAsRefType","source":{"path":"src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx","lineNumber":137,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L137"},"returnComment":[]}],"source":{"path":"src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L41"},"initialIsOpen":false}],"functions":[{"id":"def-public.isReferenceOrValueEmbeddable","type":"Function","label":"isReferenceOrValueEmbeddable","signature":["(incoming: unknown) => boolean"],"description":[],"children":[{"type":"Unknown","label":"incoming","isRequired":true,"signature":["unknown"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts#L38"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts#L37"},"initialIsOpen":false},{"id":"def-public.defaultEmbeddableFactoryProvider","type":"Function","children":[{"type":"CompoundType","label":"def","isRequired":true,"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableFactoryDefinition","text":"EmbeddableFactoryDefinition"},""],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/default_embeddable_factory_provider.ts#L22"}}],"signature":[" x is ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IEmbeddable","text":"IEmbeddable"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"},", ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableOutput","text":"EmbeddableOutput"},">"],"description":[],"label":"isEmbeddable","source":{"path":"src/plugins/embeddable/public/lib/embeddables/is_embeddable.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/is_embeddable.ts#L11"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.isErrorEmbeddable","type":"Function","label":"isErrorEmbeddable","signature":["(embeddable: ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ErrorEmbeddable","text":"ErrorEmbeddable"}," | TEmbeddable) => boolean"],"description":[],"children":[{"type":"CompoundType","label":"embeddable","isRequired":true,"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ErrorEmbeddable","text":"ErrorEmbeddable"}," | TEmbeddable"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx#L20"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/error_embeddable.tsx#L19"},"initialIsOpen":false},{"id":"def-public.openAddPanelFlyout","type":"Function","label":"openAddPanelFlyout","signature":["(options: { embeddable: ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IContainer","text":"IContainer"},"<{}, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerInput","text":"ContainerInput"},"<{}>, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerOutput","text":"ContainerOutput"},">; getFactory: , ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerOutput","text":"ContainerOutput"},">"]},{"id":"def-public.openAddPanelFlyout.options.getFactory","type":"Function","label":"getFactory","description":[],"source":{"path":"src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx#L18"},"signature":[" IterableIterator<",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableFactory","text":"EmbeddableFactory"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"},", ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableOutput","text":"EmbeddableOutput"},", ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IEmbeddable","text":"IEmbeddable"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"}]},{"id":"def-public.openAddPanelFlyout.options.overlays","type":"Object","label":"overlays","description":[],"source":{"path":"src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx#L20"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.OverlayStart","text":"OverlayStart"}]},{"id":"def-public.openAddPanelFlyout.options.notifications","type":"Object","label":"notifications","description":[],"source":{"path":"src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx#L21"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.NotificationsStart","text":"NotificationsStart"}]},{"id":"def-public.openAddPanelFlyout.options.SavedObjectFinder","type":"CompoundType","label":"SavedObjectFinder","description":[],"source":{"path":"src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx#L22"},"signature":["React.ComponentType"]}],"source":{"path":"src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx#L16"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/open_add_panel_flyout.tsx#L16"},"initialIsOpen":false},{"id":"def-public.withEmbeddableSubscription","type":"Function","children":[{"type":"CompoundType","label":"WrappedComponent","isRequired":true,"signature":["React.ComponentType<{ input: I; output: O; embeddable: E; } & ExtraProps>"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/with_subscription.tsx","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/with_subscription.tsx#L19"}}],"signature":[" = ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IEmbeddable","text":"IEmbeddable"},", ExtraProps = {}>(WrappedComponent: React.ComponentType<{ input: I; output: O; embeddable: E; } & ExtraProps>) => React.ComponentType<{ embeddable: E; } & ExtraProps>"],"description":[],"label":"withEmbeddableSubscription","source":{"path":"src/plugins/embeddable/public/lib/embeddables/with_subscription.tsx","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/with_subscription.tsx#L13"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.isSavedObjectEmbeddableInput","type":"Function","label":"isSavedObjectEmbeddableInput","signature":["(input: ",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"}," | ",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.SavedObjectEmbeddableInput","text":"SavedObjectEmbeddableInput"},") => boolean"],"description":[],"children":[{"type":"CompoundType","label":"input","isRequired":true,"signature":[{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"}," | ",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.SavedObjectEmbeddableInput","text":"SavedObjectEmbeddableInput"}],"description":[],"source":{"path":"src/plugins/embeddable/common/lib/saved_object_embeddable.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/saved_object_embeddable.ts#L16"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/common/lib/saved_object_embeddable.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/saved_object_embeddable.ts#L15"},"initialIsOpen":false},{"id":"def-public.isRangeSelectTriggerContext","type":"Function","children":[{"type":"CompoundType","label":"context","isRequired":true,"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ChartActionContext","text":"ChartActionContext"},"<",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IEmbeddable","text":"IEmbeddable"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"},", ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableOutput","text":"EmbeddableOutput"},">>"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":107,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L107"}}],"signature":["(context: ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ChartActionContext","text":"ChartActionContext"},"<",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IEmbeddable","text":"IEmbeddable"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"},", ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableOutput","text":"EmbeddableOutput"},">>) => context is ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.RangeSelectContext","text":"RangeSelectContext"}],"description":[],"label":"isRangeSelectTriggerContext","source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":106,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L106"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.isValueClickTriggerContext","type":"Function","children":[{"type":"CompoundType","label":"context","isRequired":true,"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ChartActionContext","text":"ChartActionContext"},"<",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IEmbeddable","text":"IEmbeddable"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"},", ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableOutput","text":"EmbeddableOutput"},">>"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L103"}}],"signature":["(context: ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ChartActionContext","text":"ChartActionContext"},"<",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IEmbeddable","text":"IEmbeddable"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"},", ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableOutput","text":"EmbeddableOutput"},">>) => context is ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ValueClickContext","text":"ValueClickContext"}],"description":[],"label":"isValueClickTriggerContext","source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L102"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.isRowClickTriggerContext","type":"Function","children":[{"type":"CompoundType","label":"context","isRequired":true,"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ChartActionContext","text":"ChartActionContext"},"<",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IEmbeddable","text":"IEmbeddable"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"},", ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableOutput","text":"EmbeddableOutput"},">>"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L110"}}],"signature":["(context: ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ChartActionContext","text":"ChartActionContext"},"<",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IEmbeddable","text":"IEmbeddable"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"},", ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableOutput","text":"EmbeddableOutput"},">>) => context is ",{"pluginId":"uiActions","scope":"public","docId":"kibUiActionsPluginApi","section":"def-public.RowClickContext","text":"RowClickContext"}],"description":[],"label":"isRowClickTriggerContext","source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L110"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.isContextMenuTriggerContext","type":"Function","children":[{"type":"Unknown","label":"context","isRequired":true,"signature":["unknown"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L115"}}],"signature":["(context: unknown) => context is ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableContext","text":"EmbeddableContext"},"<",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IEmbeddable","text":"IEmbeddable"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"},", ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableOutput","text":"EmbeddableOutput"},">>"],"description":[],"label":"isContextMenuTriggerContext","source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L115"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.EmbeddableRenderer","type":"Function","children":[{"type":"CompoundType","label":"props","isRequired":true,"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableRendererProps","text":"EmbeddableRendererProps"},""],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx#L83"}}],"signature":["(props: ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableRendererProps","text":"EmbeddableRendererProps"},") => JSX.Element"],"description":["\nHelper react component to render an embeddable\nCan be used if you have an embeddable object or an embeddable factory\nSupports updating input by passing `input` prop\n"],"label":"EmbeddableRenderer","source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx#L82"},"returnComment":[],"initialIsOpen":false}],"interfaces":[{"id":"def-public.Adapters","type":"Interface","label":"Adapters","description":["\nThe interface that the adapters used to open an inspector have to fullfill."],"children":[{"id":"def-public.Adapters.requests","type":"Object","label":"requests","description":[],"source":{"path":"src/plugins/inspector/common/adapters/types.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/types.ts#L15"},"signature":[{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.RequestAdapter","text":"RequestAdapter"}," | undefined"]},{"id":"def-public.Adapters.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/plugins/inspector/common/adapters/types.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/types.ts#L16"},"signature":["any"]}],"source":{"path":"src/plugins/inspector/common/adapters/types.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/types.ts#L14"},"initialIsOpen":false},{"id":"def-public.ReferenceOrValueEmbeddable","type":"Interface","label":"ReferenceOrValueEmbeddable","signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ReferenceOrValueEmbeddable","text":"ReferenceOrValueEmbeddable"},""],"description":["\nAny embeddable that implements this interface will be able to use input that is\neither by reference (backed by a saved object) OR by value, (provided\nby the container)."],"children":[{"id":"def-public.ReferenceOrValueEmbeddable.inputIsRefType","type":"Function","label":"inputIsRefType","description":["\ndetermines whether the input is by value or by reference."],"source":{"path":"src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts#L24"},"signature":["(input: ValTypeInput | RefTypeInput) => input is RefTypeInput"]},{"id":"def-public.ReferenceOrValueEmbeddable.getInputAsValueType","type":"Function","label":"getInputAsValueType","description":["\nGets the embeddable's current input as its Value type"],"source":{"path":"src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts#L29"},"signature":["() => Promise"]},{"id":"def-public.ReferenceOrValueEmbeddable.getInputAsRefType","type":"Function","label":"getInputAsRefType","description":["\nGets the embeddable's current input as its Reference type"],"source":{"path":"src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts#L34"},"signature":["() => Promise"]}],"source":{"path":"src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts#L17"},"initialIsOpen":false},{"id":"def-public.ContainerInput","type":"Interface","label":"ContainerInput","signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerInput","text":"ContainerInput"}," extends ",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"}],"description":[],"children":[{"id":"def-public.ContainerInput.hidePanelTitles","type":"CompoundType","label":"hidePanelTitles","description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/i_container.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L25"},"signature":["boolean | undefined"]},{"id":"def-public.ContainerInput.panels","type":"Object","label":"panels","description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/i_container.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L26"},"signature":["{ [key: string]: ",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.PanelState","text":"PanelState"},"; }"]}],"source":{"path":"src/plugins/embeddable/public/lib/containers/i_container.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L24"},"initialIsOpen":false},{"id":"def-public.ContainerOutput","type":"Interface","label":"ContainerOutput","signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerOutput","text":"ContainerOutput"}," extends ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableOutput","text":"EmbeddableOutput"}],"description":[],"children":[{"id":"def-public.ContainerOutput.embeddableLoaded","type":"Object","label":"embeddableLoaded","description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/i_container.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L21"},"signature":["{ [key: string]: boolean; }"]}],"source":{"path":"src/plugins/embeddable/public/lib/containers/i_container.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L20"},"initialIsOpen":false},{"id":"def-public.EmbeddableChildPanelProps","type":"Interface","label":"EmbeddableChildPanelProps","description":[],"children":[{"id":"def-public.EmbeddableChildPanelProps.embeddableId","type":"string","label":"embeddableId","description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx#L19"}},{"id":"def-public.EmbeddableChildPanelProps.className","type":"string","label":"className","description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx#L20"},"signature":["string | undefined"]},{"id":"def-public.EmbeddableChildPanelProps.container","type":"Object","label":"container","description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx#L21"},"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IContainer","text":"IContainer"},"<{}, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerInput","text":"ContainerInput"},"<{}>, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerOutput","text":"ContainerOutput"},">"]},{"id":"def-public.EmbeddableChildPanelProps.PanelComponent","type":"Function","label":"PanelComponent","description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx#L22"},"signature":["React.FC<{ embeddable: ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IEmbeddable","text":"IEmbeddable"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"},", ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableOutput","text":"EmbeddableOutput"},">; hideHeader?: boolean | undefined; }>"]}],"source":{"path":"src/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/embeddable_child_panel.tsx#L18"},"initialIsOpen":false},{"id":"def-public.EmbeddableContext","type":"Interface","label":"EmbeddableContext","signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableContext","text":"EmbeddableContext"},""],"description":[],"children":[{"id":"def-public.EmbeddableContext.embeddable","type":"Uncategorized","label":"embeddable","description":[],"source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L15"},"signature":["T"]}],"source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L14"},"initialIsOpen":false},{"id":"def-public.EmbeddableFactory","type":"Interface","label":"EmbeddableFactory","signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableFactory","text":"EmbeddableFactory"}," extends ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.PersistableState","text":"PersistableState"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableStateWithType","text":"EmbeddableStateWithType"},">"],"description":["\nEmbeddableFactories create and initialize an embeddable instance"],"children":[{"id":"def-public.EmbeddableFactory.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L41"}},{"id":"def-public.EmbeddableFactory.isEditable","type":"Function","label":"isEditable","description":["\nReturns whether the current user should be allowed to edit this type of\nembeddable. Most of the time this should be based off the capabilities service, hence it's async."],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L47"},"signature":["() => Promise"]},{"id":"def-public.EmbeddableFactory.savedObjectMetaData","type":"Object","label":"savedObjectMetaData","description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L49"},"signature":[{"pluginId":"savedObjects","scope":"public","docId":"kibSavedObjectsPluginApi","section":"def-public.SavedObjectMetaData","text":"SavedObjectMetaData"}," | undefined"]},{"id":"def-public.EmbeddableFactory.isContainerType","type":"boolean","label":"isContainerType","description":["\nTrue if is this factory create embeddables that are Containers. Used in the add panel to\nconditionally show whether these can be added to another container. It's just not\nsupported right now, but once nested containers are officially supported we can probably get\nrid of this interface."],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L57"}},{"id":"def-public.EmbeddableFactory.getDisplayName","type":"Function","label":"getDisplayName","signature":["() => string"],"description":["\nReturns a display name for this type of embeddable. Used in \"Create new... \" options\nin the add panel for containers."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L63"}},{"id":"def-public.EmbeddableFactory.canCreateNew","type":"Function","label":"canCreateNew","signature":["() => boolean"],"description":["\nIf false, this type of embeddable can't be created with the \"createNew\" functionality. Instead,\nuse createFromSavedObject, where an existing saved object must first exist."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L69"}},{"id":"def-public.EmbeddableFactory.getDefaultInput","type":"Function","label":"getDefaultInput","signature":["(partial: Partial) => Partial"],"description":["\nCan be used to get any default input, to be passed in to during the creation process. Default\ninput will not be stored in a parent container, so any inherited input from a container will trump\ndefault input parameters."],"children":[{"type":"Object","label":"partial","isRequired":true,"signature":["Partial"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L77"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L77"}},{"id":"def-public.EmbeddableFactory.getExplicitInput","type":"Function","label":"getExplicitInput","signature":["() => Promise>"],"description":["\nCan be used to request explicit input from the user, to be passed in to `EmbeddableFactory:create`.\nExplicit input is stored on the parent container for this embeddable. It overrides any inherited\ninput passed down from the parent container."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L84"}},{"id":"def-public.EmbeddableFactory.createFromSavedObject","type":"Function","label":"createFromSavedObject","signature":["(savedObjectId: string, input: Partial, parent?: ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IContainer","text":"IContainer"},"<{}, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerInput","text":"ContainerInput"},"<{}>, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerOutput","text":"ContainerOutput"},"> | undefined) => Promise"],"description":["\nCreates a new embeddable instance based off the saved object id."],"children":[{"type":"string","label":"savedObjectId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L94"}},{"type":"Object","label":"input","isRequired":true,"signature":["Partial"],"description":["- some input may come from a parent, or user, if it's not stored with the saved object. For example, the time\nrange of the parent container."],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L95"}},{"type":"Object","label":"parent","isRequired":false,"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IContainer","text":"IContainer"},"<{}, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerInput","text":"ContainerInput"},"<{}>, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerOutput","text":"ContainerOutput"},"> | undefined"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L96"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts","lineNumber":93,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L93"}},{"id":"def-public.EmbeddableFactory.create","type":"Function","label":"create","signature":["(initialInput: TEmbeddableInput, parent?: ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IContainer","text":"IContainer"},"<{}, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerInput","text":"ContainerInput"},"<{}>, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerOutput","text":"ContainerOutput"},"> | undefined) => Promise"],"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."],"children":[{"type":"Uncategorized","label":"initialInput","isRequired":true,"signature":["TEmbeddableInput"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts","lineNumber":106,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L106"}},{"type":"Object","label":"parent","isRequired":false,"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IContainer","text":"IContainer"},"<{}, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerInput","text":"ContainerInput"},"<{}>, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerOutput","text":"ContainerOutput"},"> | undefined"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts","lineNumber":107,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L107"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts","lineNumber":105,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L105"}}],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L30"},"initialIsOpen":false},{"id":"def-public.EmbeddableInstanceConfiguration","type":"Interface","label":"EmbeddableInstanceConfiguration","description":[],"children":[{"id":"def-public.EmbeddableInstanceConfiguration.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L19"}},{"id":"def-public.EmbeddableInstanceConfiguration.savedObjectId","type":"string","label":"savedObjectId","description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L20"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L18"},"initialIsOpen":false},{"id":"def-public.EmbeddableOutput","type":"Interface","label":"EmbeddableOutput","description":[],"children":[{"id":"def-public.EmbeddableOutput.loading","type":"CompoundType","label":"loading","description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L23"},"signature":["boolean | undefined"]},{"id":"def-public.EmbeddableOutput.error","type":"Object","label":"error","description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L25"},"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableError","text":"EmbeddableError"}," | undefined"]},{"id":"def-public.EmbeddableOutput.editUrl","type":"string","label":"editUrl","description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L26"},"signature":["string | undefined"]},{"id":"def-public.EmbeddableOutput.editApp","type":"string","label":"editApp","description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L27"},"signature":["string | undefined"]},{"id":"def-public.EmbeddableOutput.editPath","type":"string","label":"editPath","description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L28"},"signature":["string | undefined"]},{"id":"def-public.EmbeddableOutput.defaultTitle","type":"string","label":"defaultTitle","description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L29"},"signature":["string | undefined"]},{"id":"def-public.EmbeddableOutput.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L30"},"signature":["string | undefined"]},{"id":"def-public.EmbeddableOutput.editable","type":"CompoundType","label":"editable","description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L31"},"signature":["boolean | undefined"]},{"id":"def-public.EmbeddableOutput.savedObjectId","type":"string","label":"savedObjectId","description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L32"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L21"},"initialIsOpen":false},{"id":"def-public.ValueClickContext","type":"Interface","label":"ValueClickContext","signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ValueClickContext","text":"ValueClickContext"},""],"description":[],"children":[{"id":"def-public.ValueClickContext.embeddable","type":"Uncategorized","label":"embeddable","description":[],"source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L19"},"signature":["T | undefined"]},{"id":"def-public.ValueClickContext.data","type":"Object","label":"data","description":[],"source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L20"},"signature":["{ data: { table: Pick<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"},", \"rows\" | \"columns\">; column: number; row: number; value: any; }[]; timeFieldName?: string | undefined; negate?: boolean | undefined; }"]}],"source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L18"},"initialIsOpen":false},{"id":"def-public.RangeSelectContext","type":"Interface","label":"RangeSelectContext","signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.RangeSelectContext","text":"RangeSelectContext"},""],"description":[],"children":[{"id":"def-public.RangeSelectContext.embeddable","type":"Uncategorized","label":"embeddable","description":[],"source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L33"},"signature":["T | undefined"]},{"id":"def-public.RangeSelectContext.data","type":"Object","label":"data","description":[],"source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L34"},"signature":["{ table: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"},"; column: number; range: number[]; timeFieldName?: string | undefined; }"]}],"source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L32"},"initialIsOpen":false},{"id":"def-public.IContainer","type":"Interface","label":"IContainer","signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IContainer","text":"IContainer"}," extends ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IEmbeddable","text":"IEmbeddable"},""],"description":[],"children":[{"id":"def-public.IContainer.untilEmbeddableLoaded","type":"Function","label":"untilEmbeddableLoaded","signature":[">(id: string) => Promise<",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ErrorEmbeddable","text":"ErrorEmbeddable"}," | TEmbeddable>"],"description":["\nCall if you want to wait until an embeddable with that id has finished loading."],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/i_container.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L40"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/i_container.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L39"}},{"id":"def-public.IContainer.getInputForChild","type":"Function","label":"getInputForChild","signature":["(id: string) => EEI"],"description":["\nReturns the input for the given child. Uses a combination of explicit input\nfor the child stored on the parent and derived/inherited input taken from the\ncontainer itself."],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/i_container.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L49"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/i_container.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L49"}},{"id":"def-public.IContainer.updateInputForChild","type":"Function","label":"updateInputForChild","signature":["(id: string, changes: Partial) => void"],"description":["\nChanges the input for a given child. Note, this will override any inherited state taken from\nthe container itself."],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/i_container.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L57"}},{"type":"Object","label":"changes","isRequired":true,"signature":["Partial"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/i_container.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L57"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/i_container.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L57"}},{"id":"def-public.IContainer.getChild","type":"Function","label":"getChild","signature":[" = ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.Embeddable","text":"Embeddable"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"}],"description":["\nReturns the child embeddable with the given id."],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/i_container.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L63"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/i_container.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L63"}},{"id":"def-public.IContainer.removeEmbeddable","type":"Function","label":"removeEmbeddable","signature":["(embeddableId: string) => void"],"description":["\nRemoves the embeddable with the given id."],"children":[{"type":"string","label":"embeddableId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/i_container.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L69"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/i_container.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L69"}},{"id":"def-public.IContainer.addNewEmbeddable","type":"Function","label":"addNewEmbeddable","signature":[""],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/i_container.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L81"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/containers/i_container.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L75"}}],"source":{"path":"src/plugins/embeddable/public/lib/containers/i_container.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/containers/i_container.ts#L31"},"initialIsOpen":false},{"id":"def-public.IEmbeddable","type":"Interface","label":"IEmbeddable","signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IEmbeddable","text":"IEmbeddable"},""],"description":[],"children":[{"id":"def-public.IEmbeddable.isContainer","type":"boolean","label":"isContainer","description":["\nIs this embeddable an instance of a Container class, can it contain\nnested embeddables?"],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L43"}},{"id":"def-public.IEmbeddable.parent","type":"Object","label":"parent","description":["\nIf this embeddable is nested inside a container, this will contain\na reference to its parent."],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L49"},"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IContainer","text":"IContainer"},"<{}, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerInput","text":"ContainerInput"},"<{}>, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerOutput","text":"ContainerOutput"},"> | undefined"]},{"id":"def-public.IEmbeddable.type","type":"string","label":"type","description":["\nThe type of embeddable, this is what will be used to take a serialized\nembeddable and find the correct factory for which to create an instance of it."],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L55"}},{"id":"def-public.IEmbeddable.id","type":"string","label":"id","description":["\nA unique identifier for this embeddable. Mainly only used by containers to map their\nPanel States to a child embeddable instance."],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L61"}},{"id":"def-public.IEmbeddable.runtimeId","type":"number","label":"runtimeId","description":["\nUnique ID an embeddable is assigned each time it is initialized. This ID\nis different for different instances of the same embeddable. For example,\nif the same dashboard is rendered twice on the screen, all embeddable\ninstances will have a unique `runtimeId`."],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L69"},"signature":["number | undefined"]},{"id":"def-public.IEmbeddable.enhancements","type":"Uncategorized","label":"enhancements","description":["\nExtra abilities added to Embeddable by `*_enhanced` plugins."],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L74"},"signature":["object | undefined"]},{"id":"def-public.IEmbeddable.fatalError","type":"Object","label":"fatalError","description":["\nIf this embeddable has encountered a fatal error, that error will be stored here"],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L79"},"signature":["Error | undefined"]},{"id":"def-public.IEmbeddable.getIsContainer","type":"Function","label":"getIsContainer","signature":["() => this is ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IContainer","text":"IContainer"},"<{}, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerInput","text":"ContainerInput"},"<{}>, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerOutput","text":"ContainerOutput"},">"],"description":["\nA functional representation of the isContainer variable, but helpful for typescript to\nknow the shape if this returns true"],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":85,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L85"}},{"id":"def-public.IEmbeddable.getInput","type":"Function","label":"getInput","signature":["() => Readonly"],"description":["\nGet the input used to instantiate this embeddable. The input is a serialized representation of\nthis embeddable instance and can be used to clone or re-instantiate it. Input state:\n\n- Can be updated externally\n- Can change multiple times for a single embeddable instance.\n\nExamples: title, pie slice colors, custom search columns and sort order."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L96"}},{"id":"def-public.IEmbeddable.getOutput","type":"Function","label":"getOutput","signature":["() => Readonly"],"description":["\nOutput state is:\n\n- State that should not change once the embeddable is instantiated, or\n- State that is derived from the input state, or\n- State that only the embeddable instance itself knows about, or the factory.\n\nExamples: editUrl, title taken from a saved object, if your input state was first name and\n last name, your output state could be greeting."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L108"}},{"id":"def-public.IEmbeddable.updateInput","type":"Function","label":"updateInput","signature":["(changes: Partial) => void"],"description":["\nUpdates input state with the given changes."],"children":[{"type":"Object","label":"changes","isRequired":true,"signature":["Partial"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":114,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L114"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":114,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L114"}},{"id":"def-public.IEmbeddable.getInput$","type":"Function","label":"getInput$","signature":["() => Readonly<","Observable",">"],"description":["\nReturns an observable which will be notified when input state changes."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":119,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L119"}},{"id":"def-public.IEmbeddable.getOutput$","type":"Function","label":"getOutput$","signature":["() => Readonly<","Observable",">"],"description":["\nReturns an observable which will be notified when output state changes."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":124,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L124"}},{"id":"def-public.IEmbeddable.getTitle","type":"Function","label":"getTitle","signature":["() => string | undefined"],"description":["\nReturns the title of this embeddable."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":129,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L129"}},{"id":"def-public.IEmbeddable.getRoot","type":"Function","label":"getRoot","signature":["() => ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IEmbeddable","text":"IEmbeddable"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"},", ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableOutput","text":"EmbeddableOutput"},"> | ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IContainer","text":"IContainer"},"<{}, ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ContainerInput","text":"ContainerInput"}],"description":["\nReturns the top most parent embeddable, or itself if this embeddable\nis not within a parent."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":135,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L135"}},{"id":"def-public.IEmbeddable.render","type":"Function","label":"render","signature":["(domNode: Element | HTMLElement) => void"],"description":["\nRenders the embeddable at the given node."],"children":[{"type":"CompoundType","label":"domNode","isRequired":true,"signature":["Element | HTMLElement"],"description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":141,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L141"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":141,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L141"}},{"id":"def-public.IEmbeddable.reload","type":"Function","label":"reload","signature":["() => void"],"description":["\nReload the embeddable so output and rendering is up to date. Especially relevant\nif the embeddable takes relative time as input (e.g. now to now-15)"],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":147,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L147"}},{"id":"def-public.IEmbeddable.getInspectorAdapters","type":"Function","label":"getInspectorAdapters","signature":["() => ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"}," | undefined"],"description":["\nAn embeddable can return inspector adapters if it wants the inspector to be\navailable via the context menu of that panel."],"children":[],"tags":["return"],"returnComment":["Inspector adapters that will be used to open an inspector for."],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":154,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L154"}},{"id":"def-public.IEmbeddable.destroy","type":"Function","label":"destroy","signature":["() => void"],"description":["\nCleans up subscriptions, destroy nodes mounted from calls to render."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":159,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L159"}},{"id":"def-public.IEmbeddable.supportedTriggers","type":"Function","label":"supportedTriggers","signature":["() => string[]"],"description":["\nList of triggers that this embeddable will execute."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":164,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L164"}}],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/i_embeddable.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/i_embeddable.ts#L35"},"initialIsOpen":false},{"id":"def-public.OutputSpec","type":"Interface","label":"OutputSpec","description":[],"children":[{"id":"def-public.OutputSpec.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L24"},"signature":["any"]}],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts#L23"},"initialIsOpen":false},{"id":"def-public.PanelState","type":"Interface","label":"PanelState","signature":[{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.PanelState","text":"PanelState"},""],"description":[],"children":[{"id":"def-public.PanelState.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/embeddable/common/types.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L57"}},{"id":"def-public.PanelState.explicitInput","type":"CompoundType","label":"explicitInput","description":[],"source":{"path":"src/plugins/embeddable/common/types.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L62"},"signature":["Partial & { id: string; }"]}],"source":{"path":"src/plugins/embeddable/common/types.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L54"},"initialIsOpen":false},{"id":"def-public.PropertySpec","type":"Interface","label":"PropertySpec","description":[],"children":[{"id":"def-public.PropertySpec.displayName","type":"string","label":"displayName","description":[],"source":{"path":"src/plugins/embeddable/public/lib/types.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/types.ts#L18"}},{"id":"def-public.PropertySpec.accessPath","type":"string","label":"accessPath","description":[],"source":{"path":"src/plugins/embeddable/public/lib/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/types.ts#L19"}},{"id":"def-public.PropertySpec.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/embeddable/public/lib/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/types.ts#L20"}},{"id":"def-public.PropertySpec.description","type":"string","label":"description","description":[],"source":{"path":"src/plugins/embeddable/public/lib/types.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/types.ts#L21"}},{"id":"def-public.PropertySpec.value","type":"string","label":"value","description":[],"source":{"path":"src/plugins/embeddable/public/lib/types.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/types.ts#L22"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/embeddable/public/lib/types.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/types.ts#L17"},"initialIsOpen":false},{"id":"def-public.SavedObjectEmbeddableInput","type":"Interface","label":"SavedObjectEmbeddableInput","signature":[{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.SavedObjectEmbeddableInput","text":"SavedObjectEmbeddableInput"}," extends ",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"}],"description":[],"children":[{"id":"def-public.SavedObjectEmbeddableInput.savedObjectId","type":"string","label":"savedObjectId","description":[],"source":{"path":"src/plugins/embeddable/common/lib/saved_object_embeddable.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/saved_object_embeddable.ts#L12"}}],"source":{"path":"src/plugins/embeddable/common/lib/saved_object_embeddable.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/saved_object_embeddable.ts#L11"},"initialIsOpen":false},{"id":"def-public.EmbeddableEditorState","type":"Interface","label":"EmbeddableEditorState","description":["\nA state package that contains information an editor will need to create or edit an embeddable then redirect back."],"children":[{"id":"def-public.EmbeddableEditorState.originatingApp","type":"string","label":"originatingApp","description":[],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/types.ts#L19"}},{"id":"def-public.EmbeddableEditorState.embeddableId","type":"string","label":"embeddableId","description":[],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/types.ts#L20"},"signature":["string | undefined"]},{"id":"def-public.EmbeddableEditorState.valueInput","type":"Object","label":"valueInput","description":[],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/types.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/types.ts#L21"},"signature":[{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"}," | undefined"]}],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/types.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/types.ts#L18"},"initialIsOpen":false},{"id":"def-public.EmbeddablePackageState","type":"Interface","label":"EmbeddablePackageState","description":["\nA state package that contains all fields necessary to create or update an embeddable by reference or by value in a container."],"children":[{"id":"def-public.EmbeddablePackageState.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/types.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/types.ts#L35"}},{"id":"def-public.EmbeddablePackageState.input","type":"CompoundType","label":"input","description":[],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/types.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/types.ts#L36"},"signature":["Optional","<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"},", \"id\"> | ","Optional","<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.SavedObjectEmbeddableInput","text":"SavedObjectEmbeddableInput"},", \"id\">"]},{"id":"def-public.EmbeddablePackageState.embeddableId","type":"string","label":"embeddableId","description":[],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/types.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/types.ts#L37"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/embeddable/public/lib/state_transfer/types.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/state_transfer/types.ts#L34"},"initialIsOpen":false},{"id":"def-public.EnhancementRegistryDefinition","type":"Interface","label":"EnhancementRegistryDefinition","signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EnhancementRegistryDefinition","text":"EnhancementRegistryDefinition"},"

extends Partial<",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.PersistableState","text":"PersistableState"},"

>"],"description":[],"children":[{"id":"def-public.EnhancementRegistryDefinition.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/embeddable/public/types.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/types.ts#L28"}}],"source":{"path":"src/plugins/embeddable/public/types.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/types.ts#L26"},"initialIsOpen":false},{"id":"def-public.EmbeddableSetupDependencies","type":"Interface","label":"EmbeddableSetupDependencies","description":[],"children":[{"id":"def-public.EmbeddableSetupDependencies.uiActions","type":"Object","label":"uiActions","description":[],"source":{"path":"src/plugins/embeddable/public/plugin.tsx","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L54"},"signature":["Pick<",{"pluginId":"uiActions","scope":"public","docId":"kibUiActionsPluginApi","section":"def-public.UiActionsService","text":"UiActionsService"},", \"addTriggerAction\" | \"attachAction\" | \"detachAction\" | \"registerAction\" | \"registerTrigger\" | \"unregisterAction\">"]}],"source":{"path":"src/plugins/embeddable/public/plugin.tsx","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L53"},"initialIsOpen":false},{"id":"def-public.EmbeddableStartDependencies","type":"Interface","label":"EmbeddableStartDependencies","description":[],"children":[{"id":"def-public.EmbeddableStartDependencies.uiActions","type":"Object","label":"uiActions","description":[],"source":{"path":"src/plugins/embeddable/public/plugin.tsx","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L58"},"signature":["Pick<",{"pluginId":"uiActions","scope":"public","docId":"kibUiActionsPluginApi","section":"def-public.UiActionsService","text":"UiActionsService"},", ","MethodKeysOf","<",{"pluginId":"uiActions","scope":"public","docId":"kibUiActionsPluginApi","section":"def-public.UiActionsService","text":"UiActionsService"},">>"]},{"id":"def-public.EmbeddableStartDependencies.inspector","type":"Object","label":"inspector","description":[],"source":{"path":"src/plugins/embeddable/public/plugin.tsx","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L59"},"signature":[{"pluginId":"inspector","scope":"public","docId":"kibInspectorPluginApi","section":"def-public.Start","text":"Start"}]}],"source":{"path":"src/plugins/embeddable/public/plugin.tsx","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L57"},"initialIsOpen":false}],"enums":[{"id":"def-public.ViewMode","type":"Enum","label":"ViewMode","description":[],"source":{"path":"src/plugins/embeddable/common/types.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L11"},"initialIsOpen":false}],"misc":[{"id":"def-public.ACTION_ADD_PANEL","type":"string","label":"ACTION_ADD_PANEL","description":[],"source":{"path":"src/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/panel/panel_header/panel_actions/add_panel/add_panel_action.ts#L17"},"signature":["\"ACTION_ADD_PANEL\""],"initialIsOpen":false},{"id":"def-public.ACTION_EDIT_PANEL","type":"string","label":"ACTION_EDIT_PANEL","description":[],"source":{"path":"src/plugins/embeddable/public/lib/actions/edit_panel_action.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/actions/edit_panel_action.ts#L25"},"signature":["\"editPanel\""],"initialIsOpen":false},{"id":"def-public.ChartActionContext","type":"Type","label":"ChartActionContext","description":[],"source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L42"},"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.ValueClickContext","text":"ValueClickContext"}," | ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.RangeSelectContext","text":"RangeSelectContext"}," | ",{"pluginId":"uiActions","scope":"public","docId":"kibUiActionsPluginApi","section":"def-public.RowClickContext","text":"RowClickContext"}],"initialIsOpen":false},{"id":"def-public.CONTEXT_MENU_TRIGGER","type":"string","label":"CONTEXT_MENU_TRIGGER","description":[],"source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L47"},"signature":["\"CONTEXT_MENU_TRIGGER\""],"initialIsOpen":false},{"id":"def-public.EmbeddableFactoryDefinition","type":"Type","label":"EmbeddableFactoryDefinition","description":[],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_factory_definition.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_factory_definition.ts#L14"},"signature":["Pick, \"type\" | \"create\" | \"isEditable\" | \"getDisplayName\"> & Partial, \"createFromSavedObject\" | \"isContainerType\" | \"getExplicitInput\" | \"savedObjectMetaData\" | \"canCreateNew\" | \"getDefaultInput\" | \"telemetry\" | \"extract\" | \"inject\" | \"migrations\">>"],"initialIsOpen":false},{"id":"def-public.EmbeddableInput","type":"Type","label":"EmbeddableInput","description":[],"source":{"path":"src/plugins/embeddable/common/types.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L16"},"signature":["{ viewMode?: ViewMode | undefined; title?: string | undefined; id: string; lastReloadRequestTime?: number | undefined; hidePanelTitles?: boolean | undefined; enhancements?: SerializableState | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; }"],"initialIsOpen":false},{"id":"def-public.PANEL_BADGE_TRIGGER","type":"string","label":"PANEL_BADGE_TRIGGER","description":[],"source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L58"},"signature":["\"PANEL_BADGE_TRIGGER\""],"initialIsOpen":false},{"id":"def-public.PANEL_NOTIFICATION_TRIGGER","type":"string","label":"PANEL_NOTIFICATION_TRIGGER","description":[],"source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L69"},"signature":["\"PANEL_NOTIFICATION_TRIGGER\""],"initialIsOpen":false},{"id":"def-public.SELECT_RANGE_TRIGGER","type":"string","label":"SELECT_RANGE_TRIGGER","description":[],"source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L80"},"signature":["\"SELECT_RANGE_TRIGGER\""],"initialIsOpen":false},{"id":"def-public.VALUE_CLICK_TRIGGER","type":"string","label":"VALUE_CLICK_TRIGGER","description":[],"source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":91,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L91"},"signature":["\"VALUE_CLICK_TRIGGER\""],"initialIsOpen":false},{"id":"def-public.EmbeddableRendererProps","type":"Type","label":"EmbeddableRendererProps","description":["\nThis type is a publicly exposed props of {@link EmbeddableRenderer}\nUnion is used to validate that or factory or embeddable is passed in, but it can't be both simultaneously\nIn case when embeddable is passed in, input is optional, because there is already an input inside of embeddable object\nIn case when factory is used, then input is required, because it will be used as initial input to create an embeddable object"],"source":{"path":"src/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/embeddables/embeddable_renderer.tsx#L21"},"signature":["EmbeddableRendererPropsWithEmbeddable | EmbeddableRendererWithFactory"],"initialIsOpen":false},{"id":"def-public.ATTRIBUTE_SERVICE_KEY","type":"string","label":"ATTRIBUTE_SERVICE_KEY","description":["\nThe attribute service is a shared, generic service that embeddables can use to provide the functionality\nrequired to fulfill the requirements of the ReferenceOrValueEmbeddable interface. The attribute_service\ncan also be used as a higher level wrapper to transform an embeddable input shape that references a saved object\ninto an embeddable input shape that contains that saved object's attributes by value."],"source":{"path":"src/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/attribute_service/attribute_service.tsx#L30"},"signature":["\"attributes\""],"initialIsOpen":false},{"id":"def-public.EmbeddablePanelHOC","type":"Type","label":"EmbeddablePanelHOC","description":[],"source":{"path":"src/plugins/embeddable/public/plugin.tsx","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L98"},"signature":["(props: React.PropsWithChildren<{ embeddable: ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IEmbeddable","text":"IEmbeddable"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"},", ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableOutput","text":"EmbeddableOutput"},">; hideHeader?: boolean | undefined; }>, context: any) => React.ReactElement | null"],"initialIsOpen":false}],"objects":[{"id":"def-public.contextMenuTrigger","type":"Object","children":[{"id":"def-public.contextMenuTrigger.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L49"}},{"id":"def-public.contextMenuTrigger.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L50"}},{"id":"def-public.contextMenuTrigger.description","type":"string","label":"description","description":[],"source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L53"}}],"description":[],"label":"contextMenuTrigger","source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L48"},"initialIsOpen":false},{"id":"def-public.panelBadgeTrigger","type":"Object","children":[{"id":"def-public.panelBadgeTrigger.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L60"}},{"id":"def-public.panelBadgeTrigger.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L61"}},{"id":"def-public.panelBadgeTrigger.description","type":"string","label":"description","description":[],"source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L64"}}],"description":[],"label":"panelBadgeTrigger","source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L59"},"initialIsOpen":false},{"id":"def-public.panelNotificationTrigger","type":"Object","children":[{"id":"def-public.panelNotificationTrigger.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L71"}},{"id":"def-public.panelNotificationTrigger.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L72"}},{"id":"def-public.panelNotificationTrigger.description","type":"string","label":"description","description":[],"source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L75"}}],"description":[],"label":"panelNotificationTrigger","source":{"path":"src/plugins/embeddable/public/lib/triggers/triggers.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/lib/triggers/triggers.ts#L70"},"initialIsOpen":false}],"setup":{"id":"def-public.EmbeddableSetup","type":"Interface","label":"EmbeddableSetup","description":[],"children":[{"id":"def-public.EmbeddableSetup.registerEmbeddableFactory","type":"Function","label":"registerEmbeddableFactory","description":[],"source":{"path":"src/plugins/embeddable/public/plugin.tsx","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L63"},"signature":[" = ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IEmbeddable","text":"IEmbeddable"},">(id: string, factory: ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableFactoryDefinition","text":"EmbeddableFactoryDefinition"}]},{"id":"def-public.EmbeddableSetup.registerEnhancement","type":"Function","label":"registerEnhancement","description":[],"source":{"path":"src/plugins/embeddable/public/plugin.tsx","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L71"},"signature":["(enhancement: ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EnhancementRegistryDefinition","text":"EnhancementRegistryDefinition"},"<",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},">) => void"]},{"id":"def-public.EmbeddableSetup.setCustomEmbeddableFactoryProvider","type":"Function","label":"setCustomEmbeddableFactoryProvider","description":[],"source":{"path":"src/plugins/embeddable/public/plugin.tsx","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L72"},"signature":["(customProvider: ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableFactoryProvider","text":"EmbeddableFactoryProvider"},") => void"]}],"source":{"path":"src/plugins/embeddable/public/plugin.tsx","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L62"},"lifecycle":"setup","initialIsOpen":true},"start":{"id":"def-public.EmbeddableStart","type":"Interface","label":"EmbeddableStart","signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableStart","text":"EmbeddableStart"}," extends ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.PersistableStateService","text":"PersistableStateService"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableStateWithType","text":"EmbeddableStateWithType"},">"],"description":[],"children":[{"id":"def-public.EmbeddableStart.getEmbeddableFactory","type":"Function","label":"getEmbeddableFactory","description":[],"source":{"path":"src/plugins/embeddable/public/plugin.tsx","lineNumber":76,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L76"},"signature":[" IterableIterator<",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableFactory","text":"EmbeddableFactory"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"},", ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableOutput","text":"EmbeddableOutput"},", ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IEmbeddable","text":"IEmbeddable"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"}]},{"id":"def-public.EmbeddableStart.EmbeddablePanel","type":"Function","label":"EmbeddablePanel","description":[],"source":{"path":"src/plugins/embeddable/public/plugin.tsx","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L84"},"signature":["React.FC<{ embeddable: ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IEmbeddable","text":"IEmbeddable"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"},", ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableOutput","text":"EmbeddableOutput"},">; hideHeader?: boolean | undefined; }>"]},{"id":"def-public.EmbeddableStart.getStateTransfer","type":"Function","label":"getStateTransfer","description":[],"source":{"path":"src/plugins/embeddable/public/plugin.tsx","lineNumber":85,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L85"},"signature":["(storage?: ",{"pluginId":"kibanaUtils","scope":"public","docId":"kibKibanaUtilsPluginApi","section":"def-public.Storage","text":"Storage"}," | undefined) => ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableStateTransfer","text":"EmbeddableStateTransfer"}]},{"id":"def-public.EmbeddableStart.getAttributeService","type":"Function","label":"getAttributeService","description":[],"source":{"path":"src/plugins/embeddable/public/plugin.tsx","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L86"},"signature":["(type: string, options: ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.AttributeServiceOptions","text":"AttributeServiceOptions"}]}],"source":{"path":"src/plugins/embeddable/public/plugin.tsx","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/public/plugin.tsx#L75"},"lifecycle":"start","initialIsOpen":true}},"server":{"classes":[],"functions":[],"interfaces":[{"id":"def-server.EnhancementRegistryDefinition","type":"Interface","label":"EnhancementRegistryDefinition","signature":[{"pluginId":"embeddable","scope":"server","docId":"kibEmbeddablePluginApi","section":"def-server.EnhancementRegistryDefinition","text":"EnhancementRegistryDefinition"},"

extends Partial<",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.PersistableState","text":"PersistableState"},"

>"],"description":[],"children":[{"id":"def-server.EnhancementRegistryDefinition.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/embeddable/server/types.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/server/types.ts#L21"}}],"source":{"path":"src/plugins/embeddable/server/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/server/types.ts#L19"},"initialIsOpen":false},{"id":"def-server.EmbeddableRegistryDefinition","type":"Interface","label":"EmbeddableRegistryDefinition","signature":[{"pluginId":"embeddable","scope":"server","docId":"kibEmbeddablePluginApi","section":"def-server.EmbeddableRegistryDefinition","text":"EmbeddableRegistryDefinition"},"

extends Partial<",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.PersistableState","text":"PersistableState"},"

>"],"description":[],"children":[{"id":"def-server.EmbeddableRegistryDefinition.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/embeddable/server/types.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/server/types.ts#L32"}}],"source":{"path":"src/plugins/embeddable/server/types.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/server/types.ts#L29"},"initialIsOpen":false}],"enums":[],"misc":[],"objects":[],"setup":{"id":"def-server.EmbeddableSetup","type":"Interface","label":"EmbeddableSetup","signature":[{"pluginId":"embeddable","scope":"server","docId":"kibEmbeddablePluginApi","section":"def-server.EmbeddableSetup","text":"EmbeddableSetup"}," extends ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.PersistableStateService","text":"PersistableStateService"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableStateWithType","text":"EmbeddableStateWithType"},">"],"description":[],"children":[{"id":"def-server.EmbeddableSetup.registerEmbeddableFactory","type":"Function","label":"registerEmbeddableFactory","description":[],"source":{"path":"src/plugins/embeddable/server/plugin.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/server/plugin.ts#L28"},"signature":["(factory: ",{"pluginId":"embeddable","scope":"server","docId":"kibEmbeddablePluginApi","section":"def-server.EmbeddableRegistryDefinition","text":"EmbeddableRegistryDefinition"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableStateWithType","text":"EmbeddableStateWithType"},">) => void"]},{"id":"def-server.EmbeddableSetup.registerEnhancement","type":"Function","label":"registerEnhancement","description":[],"source":{"path":"src/plugins/embeddable/server/plugin.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/server/plugin.ts#L29"},"signature":["(enhancement: ",{"pluginId":"embeddable","scope":"server","docId":"kibEmbeddablePluginApi","section":"def-server.EnhancementRegistryDefinition","text":"EnhancementRegistryDefinition"},"<",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},">) => void"]}],"source":{"path":"src/plugins/embeddable/server/plugin.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/server/plugin.ts#L27"},"lifecycle":"setup","initialIsOpen":true}},"common":{"classes":[],"functions":[{"id":"def-common.getExtractFunction","type":"Function","children":[{"type":"Object","label":"embeddables","isRequired":true,"signature":[{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.CommonEmbeddableStartContract","text":"CommonEmbeddableStartContract"}],"description":[],"source":{"path":"src/plugins/embeddable/common/lib/extract.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/extract.ts#L13"}}],"signature":["(embeddables: ",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.CommonEmbeddableStartContract","text":"CommonEmbeddableStartContract"},") => (state: ",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableStateWithType","text":"EmbeddableStateWithType"},") => { state: ",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableStateWithType","text":"EmbeddableStateWithType"},"; references: ","SavedObjectReference","[]; }"],"description":[],"label":"getExtractFunction","source":{"path":"src/plugins/embeddable/common/lib/extract.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/extract.ts#L13"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getInjectFunction","type":"Function","children":[{"type":"Object","label":"embeddables","isRequired":true,"signature":[{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.CommonEmbeddableStartContract","text":"CommonEmbeddableStartContract"}],"description":[],"source":{"path":"src/plugins/embeddable/common/lib/inject.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/inject.ts#L14"}}],"signature":["(embeddables: ",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.CommonEmbeddableStartContract","text":"CommonEmbeddableStartContract"},") => (state: ",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableStateWithType","text":"EmbeddableStateWithType"},", references: ","SavedObjectReference","[]) => ",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableStateWithType","text":"EmbeddableStateWithType"}],"description":[],"label":"getInjectFunction","source":{"path":"src/plugins/embeddable/common/lib/inject.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/inject.ts#L14"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getMigrateFunction","type":"Function","children":[{"type":"Object","label":"embeddables","isRequired":true,"signature":[{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.CommonEmbeddableStartContract","text":"CommonEmbeddableStartContract"}],"description":[],"source":{"path":"src/plugins/embeddable/common/lib/migrate.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/migrate.ts#L13"}}],"signature":["(embeddables: ",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.CommonEmbeddableStartContract","text":"CommonEmbeddableStartContract"},") => (state: ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},", version: string) => ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.SerializableState","text":"SerializableState"}],"description":[],"label":"getMigrateFunction","source":{"path":"src/plugins/embeddable/common/lib/migrate.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/migrate.ts#L13"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.telemetryBaseEmbeddableInput","type":"Function","children":[{"type":"CompoundType","label":"state","isRequired":true,"signature":[{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableStateWithType","text":"EmbeddableStateWithType"}],"description":[],"source":{"path":"src/plugins/embeddable/common/lib/migrate_base_input.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/migrate_base_input.ts#L14"}},{"type":"Object","label":"telemetryData","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/embeddable/common/lib/migrate_base_input.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/migrate_base_input.ts#L15"}}],"signature":["(state: ",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableStateWithType","text":"EmbeddableStateWithType"},", telemetryData: Record) => Record"],"description":[],"label":"telemetryBaseEmbeddableInput","source":{"path":"src/plugins/embeddable/common/lib/migrate_base_input.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/migrate_base_input.ts#L13"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.extractBaseEmbeddableInput","type":"Function","children":[{"type":"CompoundType","label":"state","isRequired":true,"signature":[{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableStateWithType","text":"EmbeddableStateWithType"}],"description":[],"source":{"path":"src/plugins/embeddable/common/lib/migrate_base_input.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/migrate_base_input.ts#L20"}}],"signature":["(state: ",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableStateWithType","text":"EmbeddableStateWithType"},") => { state: ",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableStateWithType","text":"EmbeddableStateWithType"},"; references: ","SavedObjectReference","[]; }"],"description":[],"label":"extractBaseEmbeddableInput","source":{"path":"src/plugins/embeddable/common/lib/migrate_base_input.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/migrate_base_input.ts#L20"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.injectBaseEmbeddableInput","type":"Function","children":[{"type":"CompoundType","label":"state","isRequired":true,"signature":[{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableStateWithType","text":"EmbeddableStateWithType"}],"description":[],"source":{"path":"src/plugins/embeddable/common/lib/migrate_base_input.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/migrate_base_input.ts#L25"}},{"type":"Array","label":"references","isRequired":true,"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[]"],"description":[],"source":{"path":"src/plugins/embeddable/common/lib/migrate_base_input.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/migrate_base_input.ts#L26"}}],"signature":["(state: ",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableStateWithType","text":"EmbeddableStateWithType"},", references: ","SavedObjectReference","[]) => ",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableStateWithType","text":"EmbeddableStateWithType"}],"description":[],"label":"injectBaseEmbeddableInput","source":{"path":"src/plugins/embeddable/common/lib/migrate_base_input.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/migrate_base_input.ts#L24"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getTelemetryFunction","type":"Function","children":[{"type":"Object","label":"embeddables","isRequired":true,"signature":[{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.CommonEmbeddableStartContract","text":"CommonEmbeddableStartContract"}],"description":[],"source":{"path":"src/plugins/embeddable/common/lib/telemetry.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/telemetry.ts#L12"}}],"signature":["(embeddables: ",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.CommonEmbeddableStartContract","text":"CommonEmbeddableStartContract"},") => (state: ",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableStateWithType","text":"EmbeddableStateWithType"},", telemetryData?: Record) => Record"],"description":[],"label":"getTelemetryFunction","source":{"path":"src/plugins/embeddable/common/lib/telemetry.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/telemetry.ts#L12"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.isSavedObjectEmbeddableInput","type":"Function","label":"isSavedObjectEmbeddableInput","signature":["(input: ",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"}," | ",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.SavedObjectEmbeddableInput","text":"SavedObjectEmbeddableInput"},") => boolean"],"description":[],"children":[{"type":"CompoundType","label":"input","isRequired":true,"signature":[{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"}," | ",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.SavedObjectEmbeddableInput","text":"SavedObjectEmbeddableInput"}],"description":[],"source":{"path":"src/plugins/embeddable/common/lib/saved_object_embeddable.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/saved_object_embeddable.ts#L16"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/embeddable/common/lib/saved_object_embeddable.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/saved_object_embeddable.ts#L15"},"initialIsOpen":false}],"interfaces":[{"id":"def-common.PanelState","type":"Interface","label":"PanelState","signature":[{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.PanelState","text":"PanelState"},""],"description":[],"children":[{"id":"def-common.PanelState.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/embeddable/common/types.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L57"}},{"id":"def-common.PanelState.explicitInput","type":"CompoundType","label":"explicitInput","description":[],"source":{"path":"src/plugins/embeddable/common/types.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L62"},"signature":["Partial & { id: string; }"]}],"source":{"path":"src/plugins/embeddable/common/types.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L54"},"initialIsOpen":false},{"id":"def-common.CommonEmbeddableStartContract","type":"Interface","label":"CommonEmbeddableStartContract","description":[],"children":[{"id":"def-common.CommonEmbeddableStartContract.getEmbeddableFactory","type":"Function","label":"getEmbeddableFactory","description":[],"source":{"path":"src/plugins/embeddable/common/types.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L70"},"signature":["(embeddableFactoryId: string) => any"]},{"id":"def-common.CommonEmbeddableStartContract.getEnhancement","type":"Function","label":"getEnhancement","description":[],"source":{"path":"src/plugins/embeddable/common/types.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L71"},"signature":["(enhancementId: string) => any"]}],"source":{"path":"src/plugins/embeddable/common/types.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L69"},"initialIsOpen":false},{"id":"def-common.SavedObjectEmbeddableInput","type":"Interface","label":"SavedObjectEmbeddableInput","signature":[{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.SavedObjectEmbeddableInput","text":"SavedObjectEmbeddableInput"}," extends ",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"}],"description":[],"children":[{"id":"def-common.SavedObjectEmbeddableInput.savedObjectId","type":"string","label":"savedObjectId","description":[],"source":{"path":"src/plugins/embeddable/common/lib/saved_object_embeddable.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/saved_object_embeddable.ts#L12"}}],"source":{"path":"src/plugins/embeddable/common/lib/saved_object_embeddable.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/saved_object_embeddable.ts#L11"},"initialIsOpen":false}],"enums":[{"id":"def-common.ViewMode","type":"Enum","label":"ViewMode","description":[],"source":{"path":"src/plugins/embeddable/common/types.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L11"},"initialIsOpen":false}],"misc":[{"id":"def-common.EmbeddableInput","type":"Type","label":"EmbeddableInput","description":[],"source":{"path":"src/plugins/embeddable/common/types.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L16"},"signature":["{ viewMode?: ViewMode | undefined; title?: string | undefined; id: string; lastReloadRequestTime?: number | undefined; hidePanelTitles?: boolean | undefined; enhancements?: SerializableState | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; }"],"initialIsOpen":false},{"id":"def-common.EmbeddableStateWithType","type":"Type","label":"EmbeddableStateWithType","description":[],"source":{"path":"src/plugins/embeddable/common/types.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L65"},"signature":["EmbeddableInput & { type: string; }"],"initialIsOpen":false},{"id":"def-common.EmbeddablePersistableStateService","type":"Type","label":"EmbeddablePersistableStateService","description":[],"source":{"path":"src/plugins/embeddable/common/types.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/types.ts#L67"},"signature":["PersistableStateService"],"initialIsOpen":false}],"objects":[{"id":"def-common.baseEmbeddableMigrations","type":"Object","children":[],"description":[],"label":"baseEmbeddableMigrations","source":{"path":"src/plugins/embeddable/common/lib/migrate_base_input.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/embeddable/common/lib/migrate_base_input.ts#L31"},"initialIsOpen":false}]}} \ No newline at end of file diff --git a/api_docs/embeddable.mdx b/api_docs/embeddable.mdx new file mode 100644 index 0000000000000..98fb965a4b4bc --- /dev/null +++ b/api_docs/embeddable.mdx @@ -0,0 +1,48 @@ +--- +id: kibEmbeddablePluginApi +slug: /kibana-dev-docs/embeddablePluginApi +title: embeddable +image: https://source.unsplash.com/400x175/?github +summary: API docs for the embeddable plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddable'] +--- + +import embeddableObj from './embeddable.json'; + +## Client + +### Setup + +### Start + +### Objects + +### Functions + +### Classes + +### Interfaces + +### Enums + +### Consts, variables and types + +## Server + +### Setup + +### Interfaces + +## Common + +### Objects + +### Functions + +### Interfaces + +### Enums + +### Consts, variables and types + diff --git a/api_docs/embeddable_enhanced.json b/api_docs/embeddable_enhanced.json new file mode 100644 index 0000000000000..462319603b934 --- /dev/null +++ b/api_docs/embeddable_enhanced.json @@ -0,0 +1 @@ +{"id":"embeddableEnhanced","client":{"classes":[],"functions":[{"id":"def-public.isEnhancedEmbeddable","type":"Function","children":[{"type":"Uncategorized","label":"maybeEnhancedEmbeddable","isRequired":true,"signature":["E"],"description":[],"source":{"path":"x-pack/plugins/embeddable_enhanced/public/embeddables/is_enhanced_embeddable.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/embeddables/is_enhanced_embeddable.ts#L12"}}],"signature":["(maybeEnhancedEmbeddable: E) => maybeEnhancedEmbeddable is ",{"pluginId":"embeddableEnhanced","scope":"public","docId":"kibEmbeddableEnhancedPluginApi","section":"def-public.EnhancedEmbeddable","text":"EnhancedEmbeddable"}," ? E : never>"],"description":[],"label":"isEnhancedEmbeddable","source":{"path":"x-pack/plugins/embeddable_enhanced/public/embeddables/is_enhanced_embeddable.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/embeddables/is_enhanced_embeddable.ts#L11"},"returnComment":[],"initialIsOpen":false}],"interfaces":[{"id":"def-public.SetupDependencies","type":"Interface","label":"SetupDependencies","description":[],"children":[{"id":"def-public.SetupDependencies.embeddable","type":"Object","label":"embeddable","description":[],"source":{"path":"x-pack/plugins/embeddable_enhanced/public/plugin.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/plugin.ts#L36"},"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableSetup","text":"EmbeddableSetup"}]},{"id":"def-public.SetupDependencies.uiActionsEnhanced","type":"Object","label":"uiActionsEnhanced","description":[],"source":{"path":"x-pack/plugins/embeddable_enhanced/public/plugin.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/plugin.ts#L37"},"signature":[{"pluginId":"uiActionsEnhanced","scope":"public","docId":"kibUiActionsEnhancedPluginApi","section":"def-public.SetupContract","text":"SetupContract"}]}],"source":{"path":"x-pack/plugins/embeddable_enhanced/public/plugin.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/plugin.ts#L35"},"initialIsOpen":false},{"id":"def-public.StartDependencies","type":"Interface","label":"StartDependencies","description":[],"children":[{"id":"def-public.StartDependencies.embeddable","type":"Object","label":"embeddable","description":[],"source":{"path":"x-pack/plugins/embeddable_enhanced/public/plugin.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/plugin.ts#L41"},"signature":[{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableStart","text":"EmbeddableStart"}]},{"id":"def-public.StartDependencies.uiActionsEnhanced","type":"Object","label":"uiActionsEnhanced","description":[],"source":{"path":"x-pack/plugins/embeddable_enhanced/public/plugin.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/plugin.ts#L42"},"signature":[{"pluginId":"uiActionsEnhanced","scope":"public","docId":"kibUiActionsEnhancedPluginApi","section":"def-public.StartContract","text":"StartContract"}]}],"source":{"path":"x-pack/plugins/embeddable_enhanced/public/plugin.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/plugin.ts#L40"},"initialIsOpen":false},{"id":"def-public.EnhancedEmbeddableContext","type":"Interface","label":"EnhancedEmbeddableContext","description":[],"children":[{"id":"def-public.EnhancedEmbeddableContext.embeddable","type":"CompoundType","label":"embeddable","description":[],"source":{"path":"x-pack/plugins/embeddable_enhanced/public/types.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/types.ts#L21"},"signature":[{"pluginId":"embeddableEnhanced","scope":"public","docId":"kibEmbeddableEnhancedPluginApi","section":"def-public.EnhancedEmbeddable","text":"EnhancedEmbeddable"},"<",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IEmbeddable","text":"IEmbeddable"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"},", ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableOutput","text":"EmbeddableOutput"},">>"]}],"source":{"path":"x-pack/plugins/embeddable_enhanced/public/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/types.ts#L20"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-public.EnhancedEmbeddable","type":"Type","label":"EnhancedEmbeddable","description":[],"source":{"path":"x-pack/plugins/embeddable_enhanced/public/types.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/types.ts#L11"},"signature":["E & { enhancements: { dynamicActions: DynamicActionManager;}; }"],"initialIsOpen":false},{"id":"def-public.drilldownGrouping","type":"Array","label":"drilldownGrouping","description":[],"source":{"path":"x-pack/plugins/embeddable_enhanced/public/actions/drilldown_grouping.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/actions/drilldown_grouping.ts#L12"},"signature":[{"pluginId":"uiActions","scope":"public","docId":"kibUiActionsPluginApi","section":"def-public.PresentableGrouping","text":"PresentableGrouping"},"<{ embeddable?: ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.IEmbeddable","text":"IEmbeddable"},"<",{"pluginId":"embeddable","scope":"common","docId":"kibEmbeddablePluginApi","section":"def-common.EmbeddableInput","text":"EmbeddableInput"},", ",{"pluginId":"embeddable","scope":"public","docId":"kibEmbeddablePluginApi","section":"def-public.EmbeddableOutput","text":"EmbeddableOutput"},"> | undefined; }>"],"initialIsOpen":false}],"objects":[],"setup":{"id":"def-public.SetupContract","type":"Interface","label":"SetupContract","description":[],"children":[],"source":{"path":"x-pack/plugins/embeddable_enhanced/public/plugin.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/plugin.ts#L46"},"lifecycle":"setup","initialIsOpen":true},"start":{"id":"def-public.StartContract","type":"Interface","label":"StartContract","description":[],"children":[],"source":{"path":"x-pack/plugins/embeddable_enhanced/public/plugin.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/embeddable_enhanced/public/plugin.ts#L49"},"lifecycle":"start","initialIsOpen":true}},"server":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]}} \ No newline at end of file diff --git a/api_docs/embeddable_enhanced.mdx b/api_docs/embeddable_enhanced.mdx new file mode 100644 index 0000000000000..5e4636670ce9a --- /dev/null +++ b/api_docs/embeddable_enhanced.mdx @@ -0,0 +1,24 @@ +--- +id: kibEmbeddableEnhancedPluginApi +slug: /kibana-dev-docs/embeddableEnhancedPluginApi +title: embeddableEnhanced +image: https://source.unsplash.com/400x175/?github +summary: API docs for the embeddableEnhanced plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'embeddableEnhanced'] +--- + +import embeddableEnhancedObj from './embeddable_enhanced.json'; + +## Client + +### Setup + +### Start + +### Functions + +### Interfaces + +### Consts, variables and types + diff --git a/api_docs/encrypted_saved_objects.json b/api_docs/encrypted_saved_objects.json new file mode 100644 index 0000000000000..0e4f415e55adc --- /dev/null +++ b/api_docs/encrypted_saved_objects.json @@ -0,0 +1 @@ +{"id":"encryptedSavedObjects","client":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"server":{"classes":[{"id":"def-server.EncryptionError","type":"Class","label":"EncryptionError","description":[],"signature":[{"pluginId":"encryptedSavedObjects","scope":"server","docId":"kibEncryptedSavedObjectsPluginApi","section":"def-server.EncryptionError","text":"EncryptionError"}," extends Error"],"children":[{"id":"def-server.EncryptionError.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"string","label":"message","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts#L18"}},{"type":"string","label":"attributeName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts#L19"}},{"type":"Enum","label":"operation","isRequired":true,"signature":[{"pluginId":"encryptedSavedObjects","scope":"server","docId":"kibEncryptedSavedObjectsPluginApi","section":"def-server.EncryptionErrorOperation","text":"EncryptionErrorOperation"}],"description":[],"source":{"path":"x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts#L20"}},{"type":"Object","label":"cause","isRequired":false,"signature":["Error | undefined"],"description":[],"source":{"path":"x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts#L21"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts#L17"}},{"id":"def-server.EncryptionError.toJSON","type":"Function","label":"toJSON","signature":["() => { message: string; }"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts#L30"}}],"source":{"path":"x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encryption_error.ts#L16"},"initialIsOpen":false}],"functions":[],"interfaces":[{"id":"def-server.EncryptedSavedObjectTypeRegistration","type":"Interface","label":"EncryptedSavedObjectTypeRegistration","description":["\nDescribes the registration entry for the saved object type that contain attributes that need to\nbe encrypted."],"children":[{"id":"def-server.EncryptedSavedObjectTypeRegistration.type","type":"string","label":"type","description":[],"source":{"path":"x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts#L32"}},{"id":"def-server.EncryptedSavedObjectTypeRegistration.attributesToEncrypt","type":"Object","label":"attributesToEncrypt","description":[],"source":{"path":"x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts#L33"},"signature":["ReadonlySet"]},{"id":"def-server.EncryptedSavedObjectTypeRegistration.attributesToExcludeFromAAD","type":"Object","label":"attributesToExcludeFromAAD","description":[],"source":{"path":"x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts#L34"},"signature":["ReadonlySet | undefined"]}],"source":{"path":"x-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/crypto/encrypted_saved_objects_service.ts#L31"},"initialIsOpen":false},{"id":"def-server.EncryptedSavedObjectsClient","type":"Interface","label":"EncryptedSavedObjectsClient","description":[],"children":[{"id":"def-server.EncryptedSavedObjectsClient.getDecryptedAsInternalUser","type":"Function","label":"getDecryptedAsInternalUser","description":[],"source":{"path":"x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts#L40"},"signature":["(type: string, id: string, options?: ",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsBaseOptions","text":"SavedObjectsBaseOptions"}," | undefined) => Promise<",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},">"]}],"source":{"path":"x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts#L39"},"initialIsOpen":false}],"enums":[],"misc":[],"objects":[],"setup":{"id":"def-server.EncryptedSavedObjectsPluginSetup","type":"Interface","label":"EncryptedSavedObjectsPluginSetup","description":[],"children":[{"id":"def-server.EncryptedSavedObjectsPluginSetup.canEncrypt","type":"boolean","label":"canEncrypt","description":["\nIndicates if Saved Object encryption is possible. Requires an encryption key to be explicitly set via `xpack.encryptedSavedObjects.encryptionKey`."],"source":{"path":"x-pack/plugins/encrypted_saved_objects/server/plugin.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/plugin.ts#L31"}},{"id":"def-server.EncryptedSavedObjectsPluginSetup.registerType","type":"Function","label":"registerType","description":[],"source":{"path":"x-pack/plugins/encrypted_saved_objects/server/plugin.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/plugin.ts#L32"},"signature":["(typeRegistration: ",{"pluginId":"encryptedSavedObjects","scope":"server","docId":"kibEncryptedSavedObjectsPluginApi","section":"def-server.EncryptedSavedObjectTypeRegistration","text":"EncryptedSavedObjectTypeRegistration"},") => void"]},{"id":"def-server.EncryptedSavedObjectsPluginSetup.createMigration","type":"Function","label":"createMigration","description":[],"source":{"path":"x-pack/plugins/encrypted_saved_objects/server/plugin.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/plugin.ts#L33"},"signature":[{"pluginId":"encryptedSavedObjects","scope":"server","docId":"kibEncryptedSavedObjectsPluginApi","section":"def-server.CreateEncryptedSavedObjectsMigrationFn","text":"CreateEncryptedSavedObjectsMigrationFn"}]}],"source":{"path":"x-pack/plugins/encrypted_saved_objects/server/plugin.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/plugin.ts#L27"},"lifecycle":"setup","initialIsOpen":true},"start":{"id":"def-server.EncryptedSavedObjectsPluginStart","type":"Interface","label":"EncryptedSavedObjectsPluginStart","description":[],"children":[{"id":"def-server.EncryptedSavedObjectsPluginStart.isEncryptionError","type":"Function","label":"isEncryptionError","description":[],"source":{"path":"x-pack/plugins/encrypted_saved_objects/server/plugin.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/plugin.ts#L37"},"signature":["(error: Error) => boolean"]},{"id":"def-server.EncryptedSavedObjectsPluginStart.getClient","type":"Function","label":"getClient","description":[],"source":{"path":"x-pack/plugins/encrypted_saved_objects/server/plugin.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/plugin.ts#L38"},"signature":[{"pluginId":"encryptedSavedObjects","scope":"server","docId":"kibEncryptedSavedObjectsPluginApi","section":"def-server.ClientInstanciator","text":"ClientInstanciator"}]}],"source":{"path":"x-pack/plugins/encrypted_saved_objects/server/plugin.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/encrypted_saved_objects/server/plugin.ts#L36"},"lifecycle":"start","initialIsOpen":true}},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]}} \ No newline at end of file diff --git a/api_docs/encrypted_saved_objects.mdx b/api_docs/encrypted_saved_objects.mdx new file mode 100644 index 0000000000000..7c2909929e1c6 --- /dev/null +++ b/api_docs/encrypted_saved_objects.mdx @@ -0,0 +1,22 @@ +--- +id: kibEncryptedSavedObjectsPluginApi +slug: /kibana-dev-docs/encryptedSavedObjectsPluginApi +title: encryptedSavedObjects +image: https://source.unsplash.com/400x175/?github +summary: API docs for the encryptedSavedObjects plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'encryptedSavedObjects'] +--- + +import encryptedSavedObjectsObj from './encrypted_saved_objects.json'; + +## Server + +### Setup + +### Start + +### Classes + +### Interfaces + diff --git a/api_docs/enterprise_search.json b/api_docs/enterprise_search.json new file mode 100644 index 0000000000000..533ef63ee9700 --- /dev/null +++ b/api_docs/enterprise_search.json @@ -0,0 +1 @@ +{"id":"enterpriseSearch","client":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"server":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[{"id":"def-server.ConfigType","type":"Type","label":"ConfigType","description":[],"source":{"path":"x-pack/plugins/enterprise_search/server/index.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/enterprise_search/server/index.ts#L24"},"signature":["{ readonly host?: string | undefined; readonly enabled: boolean; readonly accessCheckTimeout: number; readonly accessCheckTimeoutWarning: number; }"],"initialIsOpen":false}],"objects":[{"id":"def-server.configSchema","type":"Object","label":"configSchema","description":[],"source":{"path":"x-pack/plugins/enterprise_search/server/index.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/enterprise_search/server/index.ts#L17"},"signature":["ObjectType","<{ host: ","Type","; enabled: ","Type","; accessCheckTimeout: ","Type","; accessCheckTimeoutWarning: ","Type"],"initialIsOpen":false}]},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]}} \ No newline at end of file diff --git a/api_docs/enterprise_search.mdx b/api_docs/enterprise_search.mdx new file mode 100644 index 0000000000000..48dc0ec4a6c6d --- /dev/null +++ b/api_docs/enterprise_search.mdx @@ -0,0 +1,18 @@ +--- +id: kibEnterpriseSearchPluginApi +slug: /kibana-dev-docs/enterpriseSearchPluginApi +title: enterpriseSearch +image: https://source.unsplash.com/400x175/?github +summary: API docs for the enterpriseSearch plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'enterpriseSearch'] +--- + +import enterpriseSearchObj from './enterprise_search.json'; + +## Server + +### Objects + +### Consts, variables and types + diff --git a/api_docs/es_ui_shared.json b/api_docs/es_ui_shared.json new file mode 100644 index 0000000000000..48f7797153725 --- /dev/null +++ b/api_docs/es_ui_shared.json @@ -0,0 +1 @@ +{"id":"esUiShared","client":{"classes":[{"id":"def-public.CronEditor","type":"Class","label":"CronEditor","description":[],"signature":[{"pluginId":"esUiShared","scope":"public","docId":"kibEsUiSharedPluginApi","section":"def-public.CronEditor","text":"CronEditor"}," extends React.Component"],"children":[{"id":"def-public.CronEditor.getDerivedStateFromProps","type":"Function","label":"getDerivedStateFromProps","signature":["typeof ",{"pluginId":"esUiShared","scope":"public","docId":"kibEsUiSharedPluginApi","section":"def-public.CronEditor","text":"CronEditor"},".getDerivedStateFromProps"],"description":[],"children":[{"type":"Object","label":"props","isRequired":true,"signature":["Props"],"description":[],"source":{"path":"src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L65"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L65"}},{"id":"def-public.CronEditor.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"props","isRequired":true,"signature":["Props"],"description":[],"source":{"path":"src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L70"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L70"}},{"id":"def-public.CronEditor.onChangeFrequency","type":"Function","children":[{"type":"CompoundType","label":"frequency","isRequired":true,"signature":[{"pluginId":"esUiShared","scope":"public","docId":"kibEsUiSharedPluginApi","section":"def-public.Frequency","text":"Frequency"}],"description":[],"source":{"path":"src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L80"}}],"signature":["(frequency: ",{"pluginId":"esUiShared","scope":"public","docId":"kibEsUiSharedPluginApi","section":"def-public.Frequency","text":"Frequency"},") => void"],"description":[],"label":"onChangeFrequency","source":{"path":"src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L80"},"returnComment":[]},{"id":"def-public.CronEditor.onChangeFields","type":"Function","children":[{"type":"Object","label":"fields","isRequired":true,"signature":[{"pluginId":"esUiShared","scope":"public","docId":"kibEsUiSharedPluginApi","section":"def-public.FieldToValueMap","text":"FieldToValueMap"}],"description":[],"source":{"path":"src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L104"}}],"signature":["(fields: ",{"pluginId":"esUiShared","scope":"public","docId":"kibEsUiSharedPluginApi","section":"def-public.FieldToValueMap","text":"FieldToValueMap"},") => void"],"description":[],"label":"onChangeFields","source":{"path":"src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L104"},"returnComment":[]},{"id":"def-public.CronEditor.renderForm","type":"Function","label":"renderForm","signature":["() => JSX.Element | undefined"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx","lineNumber":140,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L140"}},{"id":"def-public.CronEditor.render","type":"Function","label":"render","signature":["() => JSX.Element"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx","lineNumber":215,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L215"}}],"source":{"path":"src/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/cron_editor/cron_editor.tsx#L64"},"initialIsOpen":false}],"functions":[{"id":"def-public.JsonEditor","type":"Function","label":"JsonEditor","description":[],"source":{"path":"src/plugins/es_ui_shared/public/components/json_editor/json_editor.tsx","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/json_editor/json_editor.tsx#L102"},"signature":["typeof JsonEditorComp"],"initialIsOpen":false},{"id":"def-public.SectionLoading","type":"Function","children":[{"type":"CompoundType","label":"{ inline, children, ...rest }","isRequired":true,"signature":["React.PropsWithChildren"],"description":[],"source":{"path":"src/plugins/es_ui_shared/public/components/section_loading/section_loading.tsx","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/section_loading/section_loading.tsx#L26"}}],"signature":["({ inline, children, ...rest }: React.PropsWithChildren) => JSX.Element"],"description":[],"label":"SectionLoading","source":{"path":"src/plugins/es_ui_shared/public/components/section_loading/section_loading.tsx","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/section_loading/section_loading.tsx#L26"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.sendRequest","type":"Function","children":[{"type":"Object","label":"httpClient","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpSetup","text":"HttpSetup"}],"description":[],"source":{"path":"src/plugins/es_ui_shared/public/request/send_request.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/send_request.ts#L29"}},{"type":"Object","label":"{ path, method, body, query, asSystemRequest }","isRequired":true,"signature":[{"pluginId":"esUiShared","scope":"public","docId":"kibEsUiSharedPluginApi","section":"def-public.SendRequestConfig","text":"SendRequestConfig"}],"description":[],"source":{"path":"src/plugins/es_ui_shared/public/request/send_request.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/send_request.ts#L30"}}],"signature":["(httpClient: ",{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpSetup","text":"HttpSetup"},", { path, method, body, query, asSystemRequest }: ",{"pluginId":"esUiShared","scope":"public","docId":"kibEsUiSharedPluginApi","section":"def-public.SendRequestConfig","text":"SendRequestConfig"},") => Promise<",{"pluginId":"esUiShared","scope":"public","docId":"kibEsUiSharedPluginApi","section":"def-public.SendRequestResponse","text":"SendRequestResponse"},">"],"description":[],"label":"sendRequest","source":{"path":"src/plugins/es_ui_shared/public/request/send_request.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/send_request.ts#L28"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.useRequest","type":"Function","children":[{"type":"Object","label":"httpClient","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpSetup","text":"HttpSetup"}],"description":[],"source":{"path":"src/plugins/es_ui_shared/public/request/use_request.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/use_request.ts#L29"}},{"type":"Object","label":"{ path, method, query, body, pollIntervalMs, initialData, deserializer }","isRequired":true,"signature":[{"pluginId":"esUiShared","scope":"public","docId":"kibEsUiSharedPluginApi","section":"def-public.UseRequestConfig","text":"UseRequestConfig"}],"description":[],"source":{"path":"src/plugins/es_ui_shared/public/request/use_request.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/use_request.ts#L30"}}],"signature":["(httpClient: ",{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpSetup","text":"HttpSetup"},", { path, method, query, body, pollIntervalMs, initialData, deserializer }: ",{"pluginId":"esUiShared","scope":"public","docId":"kibEsUiSharedPluginApi","section":"def-public.UseRequestConfig","text":"UseRequestConfig"},") => ",{"pluginId":"esUiShared","scope":"public","docId":"kibEsUiSharedPluginApi","section":"def-public.UseRequestResponse","text":"UseRequestResponse"},""],"description":[],"label":"useRequest","source":{"path":"src/plugins/es_ui_shared/public/request/use_request.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/use_request.ts#L28"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.AuthorizationProvider","type":"Function","children":[{"type":"Object","label":"{ privilegesEndpoint, httpClient, children }","isRequired":true,"signature":["Props"],"description":[],"source":{"path":"src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/authorization_provider.tsx","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/authorization_provider.tsx#L49"}}],"signature":["({ privilegesEndpoint, httpClient, children }: Props) => JSX.Element"],"description":[],"label":"AuthorizationProvider","source":{"path":"src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/authorization_provider.tsx","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/authorization_provider.tsx#L49"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.NotAuthorizedSection","type":"Function","children":[{"type":"Object","label":"{ title, message }","isRequired":true,"signature":["Props"],"description":[],"source":{"path":"src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/not_authorized_section.tsx","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/not_authorized_section.tsx#L17"}}],"signature":["({ title, message }: Props) => JSX.Element"],"description":[],"label":"NotAuthorizedSection","source":{"path":"src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/not_authorized_section.tsx","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/not_authorized_section.tsx#L17"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.WithPrivileges","type":"Function","children":[{"type":"Object","label":"{ privileges: requiredPrivileges, children }","isRequired":true,"signature":["Props"],"description":[],"source":{"path":"src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/with_privileges.tsx","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/with_privileges.tsx#L32"}}],"signature":["({ privileges: requiredPrivileges, children }: Props) => JSX.Element"],"description":[],"label":"WithPrivileges","source":{"path":"src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/with_privileges.tsx","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/with_privileges.tsx#L32"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.SectionError","type":"Function","children":[{"type":"CompoundType","label":"{\n title,\n error,\n actions,\n ...rest\n}","isRequired":true,"signature":["React.PropsWithChildren"],"description":[],"source":{"path":"src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx#L24"}}],"signature":["({ title, error, actions, ...rest }: React.PropsWithChildren) => JSX.Element"],"description":[],"label":"SectionError","source":{"path":"src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx#L24"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.useAuthorizationContext","type":"Function","children":[],"signature":["() => Authorization"],"description":[],"label":"useAuthorizationContext","source":{"path":"src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/authorization_provider.tsx","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/authorization_provider.tsx#L35"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.extractQueryParams","type":"Function","label":"extractQueryParams","signature":["(queryString: string) => ","ParsedQuery",""],"description":[],"children":[{"type":"string","label":"queryString","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/es_ui_shared/public/url/extract_query_params.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/url/extract_query_params.ts#L11"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/es_ui_shared/public/url/extract_query_params.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/url/extract_query_params.ts#L11"},"initialIsOpen":false},{"id":"def-public.attemptToURIDecode","type":"Function","children":[{"type":"string","label":"value","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"src/plugins/es_ui_shared/public/url/attempt_to_uri_decode.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/url/attempt_to_uri_decode.ts#L15"}}],"signature":["(value?: string | undefined) => string | undefined"],"description":[],"label":"attemptToURIDecode","source":{"path":"src/plugins/es_ui_shared/public/url/attempt_to_uri_decode.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/url/attempt_to_uri_decode.ts#L15"},"returnComment":[],"initialIsOpen":false}],"interfaces":[{"id":"def-public.JsonEditorState","type":"Interface","label":"JsonEditorState","signature":[{"pluginId":"esUiShared","scope":"public","docId":"kibEsUiSharedPluginApi","section":"def-public.JsonEditorState","text":"JsonEditorState"},""],"description":[],"children":[{"id":"def-public.JsonEditorState.data","type":"Object","label":"data","description":[],"source":{"path":"src/plugins/es_ui_shared/public/components/json_editor/use_json.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/json_editor/use_json.ts#L15"},"signature":["{ raw: string; format(): T; }"]},{"id":"def-public.JsonEditorState.validate","type":"Function","label":"validate","signature":["() => boolean"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/es_ui_shared/public/components/json_editor/use_json.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/json_editor/use_json.ts#L19"}},{"id":"def-public.JsonEditorState.isValid","type":"CompoundType","label":"isValid","description":[],"source":{"path":"src/plugins/es_ui_shared/public/components/json_editor/use_json.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/json_editor/use_json.ts#L20"},"signature":["boolean | undefined"]}],"source":{"path":"src/plugins/es_ui_shared/public/components/json_editor/use_json.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/json_editor/use_json.ts#L14"},"initialIsOpen":false},{"id":"def-public.SendRequestConfig","type":"Interface","label":"SendRequestConfig","description":[],"children":[{"id":"def-public.SendRequestConfig.path","type":"string","label":"path","description":[],"source":{"path":"src/plugins/es_ui_shared/public/request/send_request.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/send_request.ts#L12"}},{"id":"def-public.SendRequestConfig.method","type":"CompoundType","label":"method","description":[],"source":{"path":"src/plugins/es_ui_shared/public/request/send_request.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/send_request.ts#L13"},"signature":["\"get\" | \"post\" | \"put\" | \"delete\" | \"patch\" | \"head\""]},{"id":"def-public.SendRequestConfig.query","type":"Object","label":"query","description":[],"source":{"path":"src/plugins/es_ui_shared/public/request/send_request.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/send_request.ts#L14"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpFetchQuery","text":"HttpFetchQuery"}," | undefined"]},{"id":"def-public.SendRequestConfig.body","type":"Any","label":"body","description":[],"source":{"path":"src/plugins/es_ui_shared/public/request/send_request.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/send_request.ts#L15"},"signature":["any"]},{"id":"def-public.SendRequestConfig.asSystemRequest","type":"CompoundType","label":"asSystemRequest","description":["\nIf set, flags this as a \"system request\" to indicate that this is not a user-initiated request. For more information, see\nHttpFetchOptions#asSystemRequest."],"source":{"path":"src/plugins/es_ui_shared/public/request/send_request.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/send_request.ts#L20"},"signature":["boolean | undefined"]}],"source":{"path":"src/plugins/es_ui_shared/public/request/send_request.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/send_request.ts#L11"},"initialIsOpen":false},{"id":"def-public.SendRequestResponse","type":"Interface","label":"SendRequestResponse","signature":[{"pluginId":"esUiShared","scope":"public","docId":"kibEsUiSharedPluginApi","section":"def-public.SendRequestResponse","text":"SendRequestResponse"},""],"description":[],"children":[{"id":"def-public.SendRequestResponse.data","type":"CompoundType","label":"data","description":[],"source":{"path":"src/plugins/es_ui_shared/public/request/send_request.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/send_request.ts#L24"},"signature":["D | null"]},{"id":"def-public.SendRequestResponse.error","type":"CompoundType","label":"error","description":[],"source":{"path":"src/plugins/es_ui_shared/public/request/send_request.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/send_request.ts#L25"},"signature":["E | null"]}],"source":{"path":"src/plugins/es_ui_shared/public/request/send_request.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/send_request.ts#L23"},"initialIsOpen":false},{"id":"def-public.UseRequestConfig","type":"Interface","label":"UseRequestConfig","signature":[{"pluginId":"esUiShared","scope":"public","docId":"kibEsUiSharedPluginApi","section":"def-public.UseRequestConfig","text":"UseRequestConfig"}," extends ",{"pluginId":"esUiShared","scope":"public","docId":"kibEsUiSharedPluginApi","section":"def-public.SendRequestConfig","text":"SendRequestConfig"}],"description":[],"children":[{"id":"def-public.UseRequestConfig.pollIntervalMs","type":"number","label":"pollIntervalMs","description":[],"source":{"path":"src/plugins/es_ui_shared/public/request/use_request.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/use_request.ts#L15"},"signature":["number | undefined"]},{"id":"def-public.UseRequestConfig.initialData","type":"Any","label":"initialData","description":[],"source":{"path":"src/plugins/es_ui_shared/public/request/use_request.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/use_request.ts#L16"},"signature":["any"]},{"id":"def-public.UseRequestConfig.deserializer","type":"Function","label":"deserializer","description":[],"source":{"path":"src/plugins/es_ui_shared/public/request/use_request.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/use_request.ts#L17"},"signature":["((data: any) => any) | undefined"]}],"source":{"path":"src/plugins/es_ui_shared/public/request/use_request.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/use_request.ts#L14"},"initialIsOpen":false},{"id":"def-public.UseRequestResponse","type":"Interface","label":"UseRequestResponse","signature":[{"pluginId":"esUiShared","scope":"public","docId":"kibEsUiSharedPluginApi","section":"def-public.UseRequestResponse","text":"UseRequestResponse"},""],"description":[],"children":[{"id":"def-public.UseRequestResponse.isInitialRequest","type":"boolean","label":"isInitialRequest","description":[],"source":{"path":"src/plugins/es_ui_shared/public/request/use_request.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/use_request.ts#L21"}},{"id":"def-public.UseRequestResponse.isLoading","type":"boolean","label":"isLoading","description":[],"source":{"path":"src/plugins/es_ui_shared/public/request/use_request.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/use_request.ts#L22"}},{"id":"def-public.UseRequestResponse.error","type":"CompoundType","label":"error","description":[],"source":{"path":"src/plugins/es_ui_shared/public/request/use_request.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/use_request.ts#L23"},"signature":["E | null"]},{"id":"def-public.UseRequestResponse.data","type":"CompoundType","label":"data","description":[],"source":{"path":"src/plugins/es_ui_shared/public/request/use_request.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/use_request.ts#L24"},"signature":["D | null | undefined"]},{"id":"def-public.UseRequestResponse.resendRequest","type":"Function","label":"resendRequest","description":[],"source":{"path":"src/plugins/es_ui_shared/public/request/use_request.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/use_request.ts#L25"},"signature":["() => void"]}],"source":{"path":"src/plugins/es_ui_shared/public/request/use_request.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/request/use_request.ts#L20"},"initialIsOpen":false},{"id":"def-public.Privileges","type":"Interface","label":"Privileges","description":[],"children":[{"id":"def-public.Privileges.hasAllPrivileges","type":"boolean","label":"hasAllPrivileges","description":[],"source":{"path":"src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts#L14"}},{"id":"def-public.Privileges.missingPrivileges","type":"Object","label":"missingPrivileges","description":[],"source":{"path":"src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts#L15"},"signature":[{"pluginId":"esUiShared","scope":"common","docId":"kibEsUiSharedPluginApi","section":"def-common.MissingPrivileges","text":"MissingPrivileges"}]}],"source":{"path":"src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts#L13"},"initialIsOpen":false},{"id":"def-public.MissingPrivileges","type":"Interface","label":"MissingPrivileges","description":[],"children":[{"id":"def-public.MissingPrivileges.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts#L10"},"signature":["any"]}],"source":{"path":"src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts#L9"},"initialIsOpen":false},{"id":"def-public.Error","type":"Interface","label":"Error","description":[],"children":[{"id":"def-public.Error.error","type":"string","label":"error","description":[],"source":{"path":"src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx#L13"}},{"id":"def-public.Error.cause","type":"Array","label":"cause","description":[],"source":{"path":"src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx#L14"},"signature":["string[] | undefined"]},{"id":"def-public.Error.message","type":"string","label":"message","description":[],"source":{"path":"src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx#L15"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/section_error.tsx#L12"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-public.OnJsonEditorUpdateHandler","type":"Type","label":"OnJsonEditorUpdateHandler","description":[],"source":{"path":"src/plugins/es_ui_shared/public/components/json_editor/use_json.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/json_editor/use_json.ts#L23"},"signature":["(arg: ",{"pluginId":"esUiShared","scope":"public","docId":"kibEsUiSharedPluginApi","section":"def-public.JsonEditorState","text":"JsonEditorState"},") => void"],"initialIsOpen":false},{"id":"def-public.Frequency","type":"Type","label":"Frequency","description":[],"source":{"path":"src/plugins/es_ui_shared/public/components/cron_editor/types.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/components/cron_editor/types.ts#L9"},"signature":["\"MINUTE\" | \"HOUR\" | \"DAY\" | \"WEEK\" | \"MONTH\" | \"YEAR\""],"initialIsOpen":false}],"objects":[{"id":"def-public.indices","type":"Object","children":[{"id":"def-public.indices.INDEX_ILLEGAL_CHARACTERS_VISIBLE","type":"Array","label":"INDEX_ILLEGAL_CHARACTERS_VISIBLE","description":[],"source":{"path":"src/plugins/es_ui_shared/public/indices/index.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/indices/index.ts#L18"},"signature":["string[]"]},{"id":"def-public.indices.indexNameBeginsWithPeriod","type":"Function","label":"indexNameBeginsWithPeriod","description":[],"source":{"path":"src/plugins/es_ui_shared/public/indices/index.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/indices/index.ts#L19"},"signature":["typeof ",{"pluginId":"esUiShared","scope":"public","docId":"kibEsUiSharedPluginApi","section":"def-public.indexNameBeginsWithPeriod","text":"indexNameBeginsWithPeriod"}]},{"id":"def-public.indices.findIllegalCharactersInIndexName","type":"Function","label":"findIllegalCharactersInIndexName","description":[],"source":{"path":"src/plugins/es_ui_shared/public/indices/index.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/indices/index.ts#L20"},"signature":["typeof ",{"pluginId":"esUiShared","scope":"public","docId":"kibEsUiSharedPluginApi","section":"def-public.findIllegalCharactersInIndexName","text":"findIllegalCharactersInIndexName"}]},{"id":"def-public.indices.indexNameContainsSpaces","type":"Function","label":"indexNameContainsSpaces","description":[],"source":{"path":"src/plugins/es_ui_shared/public/indices/index.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/indices/index.ts#L21"},"signature":["typeof ",{"pluginId":"esUiShared","scope":"public","docId":"kibEsUiSharedPluginApi","section":"def-public.indexNameContainsSpaces","text":"indexNameContainsSpaces"}]}],"description":[],"label":"indices","source":{"path":"src/plugins/es_ui_shared/public/indices/index.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/public/indices/index.ts#L17"},"initialIsOpen":false},{"id":"def-public.AuthorizationContext","type":"Object","label":"AuthorizationContext","description":[],"source":{"path":"src/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/authorization_provider.tsx","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/components/authorization_provider.tsx#L33"},"signature":["React.Context"],"initialIsOpen":false}]},"server":{"classes":[],"functions":[{"id":"def-server.isEsError","type":"Function","label":"isEsError","signature":["(err: RequestError) => boolean"],"description":[],"children":[{"type":"Object","label":"err","isRequired":true,"signature":["RequestError"],"description":[],"source":{"path":"src/plugins/es_ui_shared/__packages_do_not_import__/errors/is_es_error.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/errors/is_es_error.ts#L21"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/es_ui_shared/__packages_do_not_import__/errors/is_es_error.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/errors/is_es_error.ts#L21"},"initialIsOpen":false},{"id":"def-server.handleEsError","type":"Function","children":[{"type":"Object","label":"{\n error,\n response,\n handleCustomError,\n}","isRequired":true,"signature":["EsErrorHandlerParams"],"description":[],"source":{"path":"src/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts#L22"}}],"signature":["({ error, response, handleCustomError, }: EsErrorHandlerParams) => ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.IKibanaResponse","text":"IKibanaResponse"},""],"description":[],"label":"handleEsError","source":{"path":"src/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/errors/handle_es_error.ts#L22"},"returnComment":[],"initialIsOpen":false},{"id":"def-server.parseEsError","type":"Function","children":[{"type":"string","label":"err","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/es_ui_shared/__packages_do_not_import__/errors/es_error_parser.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/errors/es_error_parser.ts#L27"}}],"signature":["(err: string) => ParsedError"],"description":[],"label":"parseEsError","source":{"path":"src/plugins/es_ui_shared/__packages_do_not_import__/errors/es_error_parser.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/errors/es_error_parser.ts#L27"},"returnComment":[],"initialIsOpen":false}],"interfaces":[],"enums":[],"misc":[],"objects":[]},"common":{"classes":[],"functions":[],"interfaces":[{"id":"def-common.Privileges","type":"Interface","label":"Privileges","description":[],"children":[{"id":"def-common.Privileges.hasAllPrivileges","type":"boolean","label":"hasAllPrivileges","description":[],"source":{"path":"src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts#L14"}},{"id":"def-common.Privileges.missingPrivileges","type":"Object","label":"missingPrivileges","description":[],"source":{"path":"src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts#L15"},"signature":[{"pluginId":"esUiShared","scope":"common","docId":"kibEsUiSharedPluginApi","section":"def-common.MissingPrivileges","text":"MissingPrivileges"}]}],"source":{"path":"src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts#L13"},"initialIsOpen":false},{"id":"def-common.MissingPrivileges","type":"Interface","label":"MissingPrivileges","description":[],"children":[{"id":"def-common.MissingPrivileges.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts#L10"},"signature":["any"]}],"source":{"path":"src/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/es_ui_shared/__packages_do_not_import__/authorization/types.ts#L9"},"initialIsOpen":false}],"enums":[],"misc":[],"objects":[]}} \ No newline at end of file diff --git a/api_docs/es_ui_shared.mdx b/api_docs/es_ui_shared.mdx new file mode 100644 index 0000000000000..5623901bcd512 --- /dev/null +++ b/api_docs/es_ui_shared.mdx @@ -0,0 +1,32 @@ +--- +id: kibEsUiSharedPluginApi +slug: /kibana-dev-docs/esUiSharedPluginApi +title: esUiShared +image: https://source.unsplash.com/400x175/?github +summary: API docs for the esUiShared plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'esUiShared'] +--- + +import esUiSharedObj from './es_ui_shared.json'; + +## Client + +### Objects + +### Functions + +### Classes + +### Interfaces + +### Consts, variables and types + +## Server + +### Functions + +## Common + +### Interfaces + diff --git a/api_docs/event_log.json b/api_docs/event_log.json new file mode 100644 index 0000000000000..e9ed976d28c09 --- /dev/null +++ b/api_docs/event_log.json @@ -0,0 +1 @@ +{"id":"eventLog","client":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"server":{"classes":[],"functions":[],"interfaces":[{"id":"def-server.IEventLogger","type":"Interface","label":"IEventLogger","description":[],"children":[{"id":"def-server.IEventLogger.logEvent","type":"Function","label":"logEvent","signature":["(properties: DeepPartial | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void"],"description":[],"children":[{"type":"Object","label":"properties","isRequired":false,"signature":["DeepPartial | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"],"description":[],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L53"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L53"}},{"id":"def-server.IEventLogger.startTiming","type":"Function","label":"startTiming","signature":["(event: DeepPartial | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void"],"description":[],"children":[{"type":"Object","label":"event","isRequired":false,"signature":["DeepPartial | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"],"description":[],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L54"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L54"}},{"id":"def-server.IEventLogger.stopTiming","type":"Function","label":"stopTiming","signature":["(event: DeepPartial | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => void"],"description":[],"children":[{"type":"Object","label":"event","isRequired":false,"signature":["DeepPartial | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"],"description":[],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L55"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L55"}}],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L52"},"initialIsOpen":false},{"id":"def-server.IEventLogClient","type":"Interface","label":"IEventLogClient","description":[],"children":[{"id":"def-server.IEventLogClient.findEventsBySavedObjectIds","type":"Function","label":"findEventsBySavedObjectIds","signature":["(type: string, ids: string[], options?: Partial<",{"pluginId":"eventLog","scope":"server","docId":"kibEventLogPluginApi","section":"def-server.FindOptionsType","text":"FindOptionsType"},"> | undefined) => Promise<",{"pluginId":"eventLog","scope":"server","docId":"kibEventLogPluginApi","section":"def-server.QueryEventsBySavedObjectResult","text":"QueryEventsBySavedObjectResult"},">"],"description":[],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L46"}},{"type":"Array","label":"ids","isRequired":true,"signature":["string[]"],"description":[],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L47"}},{"type":"Object","label":"options","isRequired":false,"signature":["Partial<",{"pluginId":"eventLog","scope":"server","docId":"kibEventLogPluginApi","section":"def-server.FindOptionsType","text":"FindOptionsType"},"> | undefined"],"description":[],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L48"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L45"}}],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L44"},"initialIsOpen":false},{"id":"def-server.QueryEventsBySavedObjectResult","type":"Interface","label":"QueryEventsBySavedObjectResult","description":[],"children":[{"id":"def-server.QueryEventsBySavedObjectResult.page","type":"number","label":"page","description":[],"source":{"path":"x-pack/plugins/event_log/server/es/cluster_client_adapter.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/es/cluster_client_adapter.ts#L35"}},{"id":"def-server.QueryEventsBySavedObjectResult.per_page","type":"number","label":"per_page","description":[],"source":{"path":"x-pack/plugins/event_log/server/es/cluster_client_adapter.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/es/cluster_client_adapter.ts#L36"}},{"id":"def-server.QueryEventsBySavedObjectResult.total","type":"number","label":"total","description":[],"source":{"path":"x-pack/plugins/event_log/server/es/cluster_client_adapter.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/es/cluster_client_adapter.ts#L37"}},{"id":"def-server.QueryEventsBySavedObjectResult.data","type":"Array","label":"data","description":[],"source":{"path":"x-pack/plugins/event_log/server/es/cluster_client_adapter.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/es/cluster_client_adapter.ts#L38"},"signature":["(Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ server_uuid?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}> | undefined)[]"]}],"source":{"path":"x-pack/plugins/event_log/server/es/cluster_client_adapter.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/es/cluster_client_adapter.ts#L34"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-server.IEvent","type":"Type","label":"IEvent","description":[],"source":{"path":"x-pack/plugins/event_log/generated/schemas.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/generated/schemas.ts#L26"},"signature":["undefined | DeepPartial | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>>"],"initialIsOpen":false},{"id":"def-server.IValidatedEvent","type":"Type","label":"IValidatedEvent","description":[],"source":{"path":"x-pack/plugins/event_log/generated/schemas.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/generated/schemas.ts#L25"},"signature":["undefined | Readonly<{ '@timestamp'?: string | undefined; kibana?: Readonly<{ server_uuid?: string | undefined; alerting?: Readonly<{ status?: string | undefined; instance_id?: string | undefined; action_group_id?: string | undefined; action_subgroup?: string | undefined; } & {}> | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>"],"initialIsOpen":false},{"id":"def-server.SAVED_OBJECT_REL_PRIMARY","type":"string","label":"SAVED_OBJECT_REL_PRIMARY","description":[],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L18"},"signature":["\"primary\""],"initialIsOpen":false}],"objects":[],"setup":{"id":"def-server.IEventLogService","type":"Interface","label":"IEventLogService","description":[],"children":[{"id":"def-server.IEventLogService.isEnabled","type":"Function","label":"isEnabled","signature":["() => boolean"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L30"}},{"id":"def-server.IEventLogService.isLoggingEntries","type":"Function","label":"isLoggingEntries","signature":["() => boolean"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L31"}},{"id":"def-server.IEventLogService.isIndexingEntries","type":"Function","label":"isIndexingEntries","signature":["() => boolean"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L32"}},{"id":"def-server.IEventLogService.registerProviderActions","type":"Function","label":"registerProviderActions","signature":["(provider: string, actions: string[]) => void"],"description":[],"children":[{"type":"string","label":"provider","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L33"}},{"type":"Array","label":"actions","isRequired":true,"signature":["string[]"],"description":[],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L33"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L33"}},{"id":"def-server.IEventLogService.isProviderActionRegistered","type":"Function","label":"isProviderActionRegistered","signature":["(provider: string, action: string) => boolean"],"description":[],"children":[{"type":"string","label":"provider","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L34"}},{"type":"string","label":"action","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L34"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L34"}},{"id":"def-server.IEventLogService.getProviderActions","type":"Function","label":"getProviderActions","signature":["() => Map>"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L35"}},{"id":"def-server.IEventLogService.registerSavedObjectProvider","type":"Function","label":"registerSavedObjectProvider","signature":["(type: string, provider: ",{"pluginId":"eventLog","scope":"server","docId":"kibEventLogPluginApi","section":"def-server.SavedObjectProvider","text":"SavedObjectProvider"},") => void"],"description":[],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L36"}},{"type":"Function","label":"provider","isRequired":true,"signature":[{"pluginId":"eventLog","scope":"server","docId":"kibEventLogPluginApi","section":"def-server.SavedObjectProvider","text":"SavedObjectProvider"}],"description":[],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L36"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L36"}},{"id":"def-server.IEventLogService.getLogger","type":"Function","label":"getLogger","signature":["(properties: DeepPartial | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined) => ",{"pluginId":"eventLog","scope":"server","docId":"kibEventLogPluginApi","section":"def-server.IEventLogger","text":"IEventLogger"}],"description":[],"children":[{"type":"Object","label":"properties","isRequired":false,"signature":["DeepPartial | undefined; saved_objects?: Readonly<{ type?: string | undefined; id?: string | undefined; rel?: string | undefined; namespace?: string | undefined; } & {}>[] | undefined; } & {}> | undefined; user?: Readonly<{ name?: string | undefined; } & {}> | undefined; error?: Readonly<{ message?: string | undefined; } & {}> | undefined; message?: string | undefined; tags?: string[] | undefined; ecs?: Readonly<{ version?: string | undefined; } & {}> | undefined; event?: Readonly<{ start?: string | undefined; end?: string | undefined; action?: string | undefined; provider?: string | undefined; duration?: number | undefined; outcome?: string | undefined; reason?: string | undefined; } & {}> | undefined; } & {}>>> | undefined"],"description":[],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L37"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L37"}}],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L29"},"lifecycle":"setup","initialIsOpen":true},"start":{"id":"def-server.IEventLogClientService","type":"Interface","label":"IEventLogClientService","description":[],"children":[{"id":"def-server.IEventLogClientService.getClient","type":"Function","label":"getClient","signature":["(request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},") => ",{"pluginId":"eventLog","scope":"server","docId":"kibEventLogPluginApi","section":"def-server.IEventLogClient","text":"IEventLogClient"}],"description":[],"children":[{"type":"Object","label":"request","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},""],"description":[],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L41"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L41"}}],"source":{"path":"x-pack/plugins/event_log/server/types.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/server/types.ts#L40"},"lifecycle":"start","initialIsOpen":true}},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[{"id":"def-common.BASE_EVENT_LOG_API_PATH","type":"string","label":"BASE_EVENT_LOG_API_PATH","description":[],"source":{"path":"x-pack/plugins/event_log/common/index.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/event_log/common/index.ts#L8"},"signature":["\"/api/event_log\""],"initialIsOpen":false}],"objects":[]}} \ No newline at end of file diff --git a/api_docs/event_log.mdx b/api_docs/event_log.mdx new file mode 100644 index 0000000000000..88f798ea2d921 --- /dev/null +++ b/api_docs/event_log.mdx @@ -0,0 +1,26 @@ +--- +id: kibEventLogPluginApi +slug: /kibana-dev-docs/eventLogPluginApi +title: eventLog +image: https://source.unsplash.com/400x175/?github +summary: API docs for the eventLog plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'eventLog'] +--- + +import eventLogObj from './event_log.json'; + +## Server + +### Setup + +### Start + +### Interfaces + +### Consts, variables and types + +## Common + +### Consts, variables and types + diff --git a/api_docs/expressions.json b/api_docs/expressions.json new file mode 100644 index 0000000000000..150b4c306be39 --- /dev/null +++ b/api_docs/expressions.json @@ -0,0 +1 @@ +{"id":"expressions","client":{"classes":[{"id":"def-public.ExpressionsPublicPlugin","type":"Class","label":"ExpressionsPublicPlugin","description":[],"signature":[{"pluginId":"expressions","scope":"public","docId":"kibExpressionsPluginApi","section":"def-public.ExpressionsPublicPlugin","text":"ExpressionsPublicPlugin"}," implements ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Plugin","text":"Plugin"},", ",{"pluginId":"expressions","scope":"public","docId":"kibExpressionsPluginApi","section":"def-public.ExpressionsStart","text":"ExpressionsStart"},", object, object>"],"children":[{"id":"def-public.ExpressionsPublicPlugin.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"initializerContext","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.PluginInitializerContext","text":"PluginInitializerContext"},""],"description":[],"source":{"path":"src/plugins/expressions/public/plugin.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L40"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/public/plugin.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L40"}},{"id":"def-public.ExpressionsPublicPlugin.setup","type":"Function","label":"setup","signature":["(core: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreSetup","text":"CoreSetup"},") => Pick<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionsService","text":"ExpressionsService"},", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">"],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreSetup","text":"CoreSetup"},""],"description":[],"source":{"path":"src/plugins/expressions/public/plugin.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L56"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/public/plugin.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L56"}},{"id":"def-public.ExpressionsPublicPlugin.start","type":"Function","label":"start","signature":["(core: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreStart","text":"CoreStart"},") => ",{"pluginId":"expressions","scope":"public","docId":"kibExpressionsPluginApi","section":"def-public.ExpressionsStart","text":"ExpressionsStart"}],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreStart","text":"CoreStart"}],"description":[],"source":{"path":"src/plugins/expressions/public/plugin.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L70"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/public/plugin.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L70"}},{"id":"def-public.ExpressionsPublicPlugin.stop","type":"Function","label":"stop","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/public/plugin.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L86"}}],"source":{"path":"src/plugins/expressions/public/plugin.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L37"},"initialIsOpen":false},{"id":"def-public.ExpressionRenderHandler","type":"Class","label":"ExpressionRenderHandler","description":[],"children":[{"id":"def-public.ExpressionRenderHandler.render$","type":"Object","label":"render$","description":[],"source":{"path":"src/plugins/expressions/public/render.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L38"},"signature":["Observable",""]},{"id":"def-public.ExpressionRenderHandler.update$","type":"Object","label":"update$","description":[],"source":{"path":"src/plugins/expressions/public/render.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L39"},"signature":["Observable",""]},{"id":"def-public.ExpressionRenderHandler.events$","type":"Object","label":"events$","description":[],"source":{"path":"src/plugins/expressions/public/render.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L40"},"signature":["Observable","<",{"pluginId":"expressions","scope":"public","docId":"kibExpressionsPluginApi","section":"def-public.ExpressionRendererEvent","text":"ExpressionRendererEvent"},">"]},{"id":"def-public.ExpressionRenderHandler.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"element","isRequired":true,"signature":["HTMLElement"],"description":[],"source":{"path":"src/plugins/expressions/public/render.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L52"}},{"type":"Object","label":"{\n onRenderError,\n renderMode,\n syncColors,\n hasCompatibleActions = async () => false,\n }","isRequired":true,"signature":[{"pluginId":"expressions","scope":"public","docId":"kibExpressionsPluginApi","section":"def-public.ExpressionRenderHandlerParams","text":"ExpressionRenderHandlerParams"}],"description":[],"source":{"path":"src/plugins/expressions/public/render.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L53"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/public/render.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L51"}},{"id":"def-public.ExpressionRenderHandler.render","type":"Function","children":[{"type":"Any","label":"value","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/public/render.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L102"}},{"type":"Any","label":"uiState","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/public/render.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L102"}}],"signature":["(value: any, uiState?: any) => Promise"],"description":[],"label":"render","source":{"path":"src/plugins/expressions/public/render.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L102"},"returnComment":[]},{"id":"def-public.ExpressionRenderHandler.destroy","type":"Function","children":[],"signature":["() => void"],"description":[],"label":"destroy","source":{"path":"src/plugins/expressions/public/render.ts","lineNumber":134,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L134"},"returnComment":[]},{"id":"def-public.ExpressionRenderHandler.getElement","type":"Function","children":[],"signature":["() => HTMLElement"],"description":[],"label":"getElement","source":{"path":"src/plugins/expressions/public/render.ts","lineNumber":143,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L143"},"returnComment":[]},{"id":"def-public.ExpressionRenderHandler.handleRenderError","type":"Function","children":[{"type":"Object","label":"error","isRequired":true,"signature":[{"pluginId":"expressions","scope":"public","docId":"kibExpressionsPluginApi","section":"def-public.ExpressionRenderError","text":"ExpressionRenderError"}],"description":[],"source":{"path":"src/plugins/expressions/public/render.ts","lineNumber":147,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L147"}}],"signature":["(error: ",{"pluginId":"expressions","scope":"public","docId":"kibExpressionsPluginApi","section":"def-public.ExpressionRenderError","text":"ExpressionRenderError"},") => void"],"description":[],"label":"handleRenderError","source":{"path":"src/plugins/expressions/public/render.ts","lineNumber":147,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L147"},"returnComment":[]}],"source":{"path":"src/plugins/expressions/public/render.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L37"},"initialIsOpen":false},{"id":"def-public.Execution","type":"Class","label":"Execution","description":[],"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Execution","text":"Execution"},""],"children":[{"id":"def-public.Execution.state","type":"Object","label":"state","description":["\nDynamic state of the execution."],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L80"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContainer","text":"ExecutionContainer"},">"]},{"id":"def-public.Execution.input","type":"Uncategorized","label":"input","description":["\nInitial input of the execution.\n\nN.B. It is initialized to `null` rather than `undefined` for legacy reasons,\nbecause in legacy interpreter it was set to `null` by default."],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L88"},"signature":["Input"]},{"id":"def-public.Execution.context","type":"Object","label":"context","description":["\nExecution context - object that allows to do side-effects. Context is passed\nto every function."],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L94"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},""]},{"id":"def-public.Execution.contract","type":"Object","label":"contract","description":["\nContract is a public representation of `Execution` instances. Contract we\ncan return to other plugins for their consumption."],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":134,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L134"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContract","text":"ExecutionContract"},""]},{"id":"def-public.Execution.expression","type":"string","label":"expression","description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":140,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L140"}},{"id":"def-public.Execution.result","type":"Object","label":"result","description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":142,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L142"},"signature":["Promise>"]},{"id":"def-public.Execution.inspectorAdapters","type":"Uncategorized","label":"inspectorAdapters","description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":146,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L146"},"signature":["InspectorAdapters"]},{"id":"def-public.Execution.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"execution","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionParams","text":"ExecutionParams"}],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":150,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L150"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":150,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L150"}},{"id":"def-public.Execution.cancel","type":"Function","label":"cancel","signature":["() => void"],"description":["\nStop execution of expression."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":192,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L192"}},{"id":"def-public.Execution.start","type":"Function","label":"start","signature":["(input?: Input) => void"],"description":["\nCall this method to start execution.\n\nN.B. `input` is initialized to `null` rather than `undefined` for legacy reasons,\nbecause in legacy interpreter it was set to `null` by default."],"children":[{"type":"Uncategorized","label":"input","isRequired":true,"signature":["Input"],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":202,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L202"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":202,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L202"}},{"id":"def-public.Execution.invokeChain","type":"Function","label":"invokeChain","signature":["(chainArr: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstFunction","text":"ExpressionAstFunction"},"[], input: unknown) => Promise"],"description":[],"children":[{"type":"Array","label":"chainArr","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstFunction","text":"ExpressionAstFunction"},"[]"],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":236,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L236"}},{"type":"Unknown","label":"input","isRequired":true,"signature":["unknown"],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":236,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L236"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":236,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L236"}},{"id":"def-public.Execution.invokeFunction","type":"Function","label":"invokeFunction","signature":["(fn: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"},", input: unknown, args: Record) => Promise"],"description":[],"children":[{"type":"Object","label":"fn","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"}],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":317,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L317"}},{"type":"Unknown","label":"input","isRequired":true,"signature":["unknown"],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":318,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L318"}},{"type":"Object","label":"args","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":319,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L319"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":316,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L316"}},{"id":"def-public.Execution.cast","type":"Function","label":"cast","signature":["(value: any, toTypeNames?: string[] | undefined) => any"],"description":[],"children":[{"type":"Any","label":"value","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":348,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L348"}},{"type":"Array","label":"toTypeNames","isRequired":false,"signature":["string[] | undefined"],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":348,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L348"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":348,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L348"}},{"id":"def-public.Execution.resolveArgs","type":"Function","label":"resolveArgs","signature":["(fnDef: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"},", input: unknown, argAsts: any) => Promise"],"description":[],"children":[{"type":"Object","label":"fnDef","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"}],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":374,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L374"}},{"type":"Unknown","label":"input","isRequired":true,"signature":["unknown"],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":374,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L374"}},{"type":"Any","label":"argAsts","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":374,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L374"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":374,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L374"}},{"id":"def-public.Execution.interpret","type":"Function","label":"interpret","signature":["(ast: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstNode","text":"ExpressionAstNode"},", input: T) => Promise"],"description":[],"children":[{"type":"CompoundType","label":"ast","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstNode","text":"ExpressionAstNode"}],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":465,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L465"}},{"type":"Uncategorized","label":"input","isRequired":true,"signature":["T"],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":465,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L465"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":465,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L465"}}],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L70"},"initialIsOpen":false},{"id":"def-public.ExecutionContract","type":"Class","label":"ExecutionContract","description":["\n`ExecutionContract` is a wrapper around `Execution` class. It provides the\nsame functionality but does not expose Expressions plugin internals."],"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContract","text":"ExecutionContract"},""],"children":[{"id":"def-public.ExecutionContract.isPending","type":"boolean","label":"isPending","description":[],"source":{"path":"src/plugins/expressions/common/execution/execution_contract.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L18"}},{"id":"def-public.ExecutionContract.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"execution","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Execution","text":"Execution"},""],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution_contract.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L24"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/execution/execution_contract.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L24"}},{"id":"def-public.ExecutionContract.cancel","type":"Function","children":[],"signature":["() => void"],"description":["\nCancel the execution of the expression. This will set abort signal\n(available in execution context) to aborted state, letting expression\nfunctions to stop their execution."],"label":"cancel","source":{"path":"src/plugins/expressions/common/execution/execution_contract.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L31"},"returnComment":[]},{"id":"def-public.ExecutionContract.getData","type":"Function","children":[],"signature":["() => Promise<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"error\", { error: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ErrorLike","text":"ErrorLike"},"; info?: ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined; }> | Output>"],"description":["\nReturns the final output of expression, if any error happens still\nwraps that error into `ExpressionValueError` type and returns that.\nThis function never throws."],"label":"getData","source":{"path":"src/plugins/expressions/common/execution/execution_contract.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L40"},"returnComment":[]},{"id":"def-public.ExecutionContract.getExpression","type":"Function","children":[],"signature":["() => string"],"description":["\nGet string representation of the expression. Returns the original string\nif execution was started from a string. If execution was started from an\nAST this method returns a string generated from AST."],"label":"getExpression","source":{"path":"src/plugins/expressions/common/execution/execution_contract.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L60"},"returnComment":[]},{"id":"def-public.ExecutionContract.getAst","type":"Function","children":[],"signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":["\nGet AST used to execute the expression."],"label":"getAst","source":{"path":"src/plugins/expressions/common/execution/execution_contract.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L67"},"returnComment":[]},{"id":"def-public.ExecutionContract.inspect","type":"Function","children":[],"signature":["() => InspectorAdapters"],"description":["\nGet Inspector adapters provided to all functions of expression through\nexecution context."],"label":"inspect","source":{"path":"src/plugins/expressions/common/execution/execution_contract.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L73"},"returnComment":[]}],"source":{"path":"src/plugins/expressions/common/execution/execution_contract.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L17"},"initialIsOpen":false},{"id":"def-public.Executor","type":"Class","label":"Executor","description":[],"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Executor","text":"Executor"}," implements ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.PersistableStateService","text":"PersistableStateService"},"<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},">"],"children":[{"id":"def-public.Executor.createWithDefaults","type":"Function","label":"createWithDefaults","signature":["typeof ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Executor","text":"Executor"},".createWithDefaults"],"description":[],"children":[{"type":"Object","label":"state","isRequired":false,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"}," | undefined"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L83"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L82"}},{"id":"def-public.Executor.state","type":"Object","label":"state","description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":91,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L91"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorContainer","text":"ExecutorContainer"},""]},{"id":"def-public.Executor.functions","type":"Object","label":"functions","description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L96"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.FunctionsRegistry","text":"FunctionsRegistry"}]},{"id":"def-public.Executor.types","type":"Object","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L101"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.TypesRegistry","text":"TypesRegistry"}]},{"id":"def-public.Executor.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"state","isRequired":false,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"}," | undefined"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L103"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L103"}},{"id":"def-public.Executor.registerFunction","type":"Function","label":"registerFunction","signature":["(functionDefinition: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"},")) => void"],"description":[],"children":[{"type":"CompoundType","label":"functionDefinition","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"},")"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L110"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":109,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L109"}},{"id":"def-public.Executor.getFunction","type":"Function","label":"getFunction","signature":["(name: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"}," | undefined"],"description":[],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":118,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L118"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":118,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L118"}},{"id":"def-public.Executor.getFunctions","type":"Function","label":"getFunctions","signature":["() => Record"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":122,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L122"}},{"id":"def-public.Executor.registerType","type":"Function","label":"registerType","signature":["(typeDefinition: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"},")) => void"],"description":[],"children":[{"type":"CompoundType","label":"typeDefinition","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"},")"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":127,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L127"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":126,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L126"}},{"id":"def-public.Executor.getType","type":"Function","label":"getType","signature":["(name: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionType","text":"ExpressionType"}," | undefined"],"description":[],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":135,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L135"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":135,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L135"}},{"id":"def-public.Executor.getTypes","type":"Function","label":"getTypes","signature":["() => Record"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":139,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L139"}},{"id":"def-public.Executor.extendContext","type":"Function","label":"extendContext","signature":["(extraContext: Record) => void"],"description":[],"children":[{"type":"Object","label":"extraContext","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":143,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L143"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":143,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L143"}},{"id":"def-public.Executor.context","type":"Object","label":"context","description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":147,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L147"},"signature":["Record"]},{"id":"def-public.Executor.run","type":"Function","label":"run","signature":["(ast: string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},", input: Input, params?: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionExecutionParams","text":"ExpressionExecutionParams"},") => Promise"],"description":["\nExecute expression and return result.\n"],"children":[{"type":"CompoundType","label":"ast","isRequired":true,"signature":["string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":["Expression AST or a string representing expression."],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":160,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L160"}},{"type":"Uncategorized","label":"input","isRequired":true,"signature":["Input"],"description":["Initial input to the first expression function."],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":161,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L161"}},{"type":"Object","label":"params","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionExecutionParams","text":"ExpressionExecutionParams"}],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":162,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L162"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":159,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L159"}},{"id":"def-public.Executor.createExecution","type":"Function","label":"createExecution","signature":["(ast: string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},", params?: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionExecutionParams","text":"ExpressionExecutionParams"},") => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Execution","text":"Execution"},""],"description":[],"children":[{"type":"CompoundType","label":"ast","isRequired":true,"signature":["string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":170,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L170"}},{"type":"Object","label":"params","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionExecutionParams","text":"ExpressionExecutionParams"}],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":171,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L171"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":169,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L169"}},{"id":"def-public.Executor.inject","type":"Function","label":"inject","signature":["(ast: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},", references: ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[]) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":[],"children":[{"type":"Object","label":"ast","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":217,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L217"}},{"type":"Array","label":"references","isRequired":true,"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[]"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":217,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L217"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":217,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L217"}},{"id":"def-public.Executor.extract","type":"Function","label":"extract","signature":["(ast: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},") => { state: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},"; references: ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[]; }"],"description":[],"children":[{"type":"Object","label":"ast","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":223,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L223"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":223,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L223"}},{"id":"def-public.Executor.telemetry","type":"Function","label":"telemetry","signature":["(ast: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},", telemetryData: Record) => Record"],"description":[],"children":[{"type":"Object","label":"ast","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":233,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L233"}},{"type":"Object","label":"telemetryData","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":233,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L233"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":233,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L233"}},{"id":"def-public.Executor.migrate","type":"Function","label":"migrate","signature":["(ast: ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},", version: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":[],"children":[{"type":"Object","label":"ast","isRequired":true,"signature":[{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.SerializableState","text":"SerializableState"}],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":241,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L241"}},{"type":"string","label":"version","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":241,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L241"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":241,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L241"}},{"id":"def-public.Executor.fork","type":"Function","label":"fork","signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Executor","text":"Executor"},""],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":250,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L250"}}],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L80"},"initialIsOpen":false},{"id":"def-public.ExpressionFunction","type":"Class","label":"ExpressionFunction","description":[],"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"}," implements ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.PersistableState","text":"PersistableState"},">"],"children":[{"id":"def-public.ExpressionFunction.name","type":"string","label":"name","description":["\nName of function"],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L22"}},{"id":"def-public.ExpressionFunction.aliases","type":"Array","label":"aliases","description":["\nAliases that can be used instead of `name`."],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L27"},"signature":["string[]"]},{"id":"def-public.ExpressionFunction.type","type":"string","label":"type","description":["\nReturn type of function. This SHOULD be supplied. We use it for UI\nand autocomplete hinting. We may also use it for optimizations in\nthe future."],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L34"}},{"id":"def-public.ExpressionFunction.fn","type":"Function","label":"fn","description":["\nFunction to run function (context, args)"],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L39"},"signature":["(input: any, params: Record, handlers: object) => any"]},{"id":"def-public.ExpressionFunction.help","type":"string","label":"help","description":["\nA short help text."],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L44"}},{"id":"def-public.ExpressionFunction.args","type":"Object","children":[],"description":["\nSpecification of expression function parameters."],"label":"args","source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L49"}},{"id":"def-public.ExpressionFunction.inputTypes","type":"Array","label":"inputTypes","description":["\nType of inputs that this function supports."],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L54"},"signature":["string[] | undefined"]},{"id":"def-public.ExpressionFunction.disabled","type":"boolean","label":"disabled","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L56"}},{"id":"def-public.ExpressionFunction.telemetry","type":"Function","label":"telemetry","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L57"},"signature":["(state: Record, telemetryData: Record) => Record"]},{"id":"def-public.ExpressionFunction.extract","type":"Function","label":"extract","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L61"},"signature":["(state: Record) => { state: Record; references: ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[]; }"]},{"id":"def-public.ExpressionFunction.inject","type":"Function","label":"inject","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L64"},"signature":["(state: Record, references: ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[]) => Record"]},{"id":"def-public.ExpressionFunction.migrations","type":"Object","label":"migrations","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L68"},"signature":["{ [key: string]: (state: ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},") => ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},"; }"]},{"id":"def-public.ExpressionFunction.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"functionDefinition","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"}],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L72"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L72"}},{"id":"def-public.ExpressionFunction.accepts","type":"Function","children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":107,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L107"}}],"signature":["(type: string) => boolean"],"description":[],"label":"accepts","source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":107,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L107"},"returnComment":[]}],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L18"},"initialIsOpen":false},{"id":"def-public.ExpressionFunctionParameter","type":"Class","label":"ExpressionFunctionParameter","description":[],"children":[{"id":"def-public.ExpressionFunctionParameter.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L12"}},{"id":"def-public.ExpressionFunctionParameter.required","type":"boolean","label":"required","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L13"}},{"id":"def-public.ExpressionFunctionParameter.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L14"}},{"id":"def-public.ExpressionFunctionParameter.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L15"},"signature":["string[]"]},{"id":"def-public.ExpressionFunctionParameter.default","type":"Any","label":"default","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L16"},"signature":["any"]},{"id":"def-public.ExpressionFunctionParameter.aliases","type":"Array","label":"aliases","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L17"},"signature":["string[]"]},{"id":"def-public.ExpressionFunctionParameter.multi","type":"boolean","label":"multi","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L18"}},{"id":"def-public.ExpressionFunctionParameter.resolve","type":"boolean","label":"resolve","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L19"}},{"id":"def-public.ExpressionFunctionParameter.options","type":"Array","label":"options","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L20"},"signature":["any[]"]},{"id":"def-public.ExpressionFunctionParameter.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L22"}},{"type":"CompoundType","label":"arg","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ArgumentType","text":"ArgumentType"},""],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L22"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L22"}},{"id":"def-public.ExpressionFunctionParameter.accepts","type":"Function","label":"accepts","signature":["(type: string) => boolean"],"description":[],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L40"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L40"}}],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L11"},"initialIsOpen":false},{"id":"def-public.ExpressionRenderer","type":"Class","label":"ExpressionRenderer","description":[],"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRenderer","text":"ExpressionRenderer"},""],"children":[{"id":"def-public.ExpressionRenderer.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L12"}},{"id":"def-public.ExpressionRenderer.displayName","type":"string","label":"displayName","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L13"}},{"id":"def-public.ExpressionRenderer.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L14"}},{"id":"def-public.ExpressionRenderer.validate","type":"Function","label":"validate","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L15"},"signature":["() => void | Error"]},{"id":"def-public.ExpressionRenderer.reuseDomNode","type":"boolean","label":"reuseDomNode","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L16"}},{"id":"def-public.ExpressionRenderer.render","type":"Function","label":"render","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L17"},"signature":["(domNode: HTMLElement, config: Config, handlers: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.IInterpreterRenderHandlers","text":"IInterpreterRenderHandlers"},") => void | Promise"]},{"id":"def-public.ExpressionRenderer.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"config","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRenderDefinition","text":"ExpressionRenderDefinition"},""],"description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L19"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L19"}}],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L11"},"initialIsOpen":false},{"id":"def-public.ExpressionRendererRegistry","type":"Class","label":"ExpressionRendererRegistry","description":[],"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRendererRegistry","text":"ExpressionRendererRegistry"}," implements ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.IRegistry","text":"IRegistry"},"<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRenderer","text":"ExpressionRenderer"},">"],"children":[{"id":"def-public.ExpressionRendererRegistry.register","type":"Function","label":"register","signature":["(definition: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionRenderDefinition","text":"AnyExpressionRenderDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionRenderDefinition","text":"AnyExpressionRenderDefinition"},")) => void"],"description":[],"children":[{"type":"CompoundType","label":"definition","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionRenderDefinition","text":"AnyExpressionRenderDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionRenderDefinition","text":"AnyExpressionRenderDefinition"},")"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L19"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L19"}},{"id":"def-public.ExpressionRendererRegistry.get","type":"Function","label":"get","signature":["(id: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRenderer","text":"ExpressionRenderer"}," | null"],"description":[],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L25"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L25"}},{"id":"def-public.ExpressionRendererRegistry.toJS","type":"Function","label":"toJS","signature":["() => Record>"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L29"}},{"id":"def-public.ExpressionRendererRegistry.toArray","type":"Function","label":"toArray","signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRenderer","text":"ExpressionRenderer"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L39"}}],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L13"},"initialIsOpen":false},{"id":"def-public.ExpressionType","type":"Class","label":"ExpressionType","description":[],"children":[{"id":"def-public.ExpressionType.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L13"}},{"id":"def-public.ExpressionType.help","type":"string","label":"help","description":["\nA short help text."],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L18"}},{"id":"def-public.ExpressionType.validate","type":"Function","label":"validate","description":["\nType validation, useful for checking function output."],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L23"},"signature":["(type: any) => void | Error"]},{"id":"def-public.ExpressionType.create","type":"Unknown","label":"create","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L25"},"signature":["unknown"]},{"id":"def-public.ExpressionType.serialize","type":"Function","label":"serialize","description":["\nOptional serialization (used when passing context around client/server)."],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L30"},"signature":["((value: any) => any) | undefined"]},{"id":"def-public.ExpressionType.deserialize","type":"Function","label":"deserialize","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L31"},"signature":["((serialized: any) => any) | undefined"]},{"id":"def-public.ExpressionType.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"definition","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"}],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L33"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L33"}},{"id":"def-public.ExpressionType.getToFn","type":"Function","children":[{"type":"string","label":"typeName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L48"}}],"signature":["(typeName: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueConverter","text":"ExpressionValueConverter"}," | undefined"],"description":[],"label":"getToFn","source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L47"},"returnComment":[]},{"id":"def-public.ExpressionType.getFromFn","type":"Function","children":[{"type":"string","label":"typeName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L53"}}],"signature":["(typeName: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueConverter","text":"ExpressionValueConverter"}," | undefined"],"description":[],"label":"getFromFn","source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L52"},"returnComment":[]},{"id":"def-public.ExpressionType.castsTo","type":"Function","children":[{"type":"Any","label":"value","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L57"}}],"signature":["(value: any) => boolean"],"description":[],"label":"castsTo","source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L57"},"returnComment":[]},{"id":"def-public.ExpressionType.castsFrom","type":"Function","children":[{"type":"Any","label":"value","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L59"}}],"signature":["(value: any) => boolean"],"description":[],"label":"castsFrom","source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L59"},"returnComment":[]},{"id":"def-public.ExpressionType.to","type":"Function","children":[{"type":"Any","label":"value","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L61"}},{"type":"string","label":"toTypeName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L61"}},{"type":"Object","label":"types","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L61"}}],"signature":["(value: any, toTypeName: string, types: Record) => any"],"description":[],"label":"to","source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L61"},"returnComment":[]},{"id":"def-public.ExpressionType.from","type":"Function","children":[{"type":"Any","label":"value","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L73"}},{"type":"Object","label":"types","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L73"}}],"signature":["(value: any, types: Record) => any"],"description":[],"label":"from","source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L73"},"returnComment":[]}],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L12"},"initialIsOpen":false},{"id":"def-public.FunctionsRegistry","type":"Class","label":"FunctionsRegistry","description":[],"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.FunctionsRegistry","text":"FunctionsRegistry"}," implements ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.IRegistry","text":"IRegistry"},"<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"},">"],"children":[{"id":"def-public.FunctionsRegistry.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"executor","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Executor","text":"Executor"},""],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L59"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L59"}},{"id":"def-public.FunctionsRegistry.register","type":"Function","label":"register","signature":["(functionDefinition: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"},")) => void"],"description":[],"children":[{"type":"CompoundType","label":"functionDefinition","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"},")"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L62"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L61"}},{"id":"def-public.FunctionsRegistry.get","type":"Function","label":"get","signature":["(id: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"}," | null"],"description":[],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L67"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L67"}},{"id":"def-public.FunctionsRegistry.toJS","type":"Function","label":"toJS","signature":["() => Record"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L71"}},{"id":"def-public.FunctionsRegistry.toArray","type":"Function","label":"toArray","signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L75"}}],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L58"},"initialIsOpen":false},{"id":"def-public.TypesRegistry","type":"Class","label":"TypesRegistry","description":[],"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.TypesRegistry","text":"TypesRegistry"}," implements ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.IRegistry","text":"IRegistry"},"<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionType","text":"ExpressionType"},">"],"children":[{"id":"def-public.TypesRegistry.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"executor","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Executor","text":"Executor"},""],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L37"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L37"}},{"id":"def-public.TypesRegistry.register","type":"Function","label":"register","signature":["(typeDefinition: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"},")) => void"],"description":[],"children":[{"type":"CompoundType","label":"typeDefinition","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"},")"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L40"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L39"}},{"id":"def-public.TypesRegistry.get","type":"Function","label":"get","signature":["(id: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionType","text":"ExpressionType"}," | null"],"description":[],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L45"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L45"}},{"id":"def-public.TypesRegistry.toJS","type":"Function","label":"toJS","signature":["() => Record"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L49"}},{"id":"def-public.TypesRegistry.toArray","type":"Function","label":"toArray","signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionType","text":"ExpressionType"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L53"}}],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L36"},"initialIsOpen":false},{"id":"def-public.ExpressionsService","type":"Class","label":"ExpressionsService","description":["\n`ExpressionsService` class is used for multiple purposes:\n\n1. It implements the same Expressions service that can be used on both:\n (1) server-side and (2) browser-side.\n2. It implements the same Expressions service that users can fork/clone,\n thus have their own instance of the Expressions plugin.\n3. `ExpressionsService` defines the public contracts of *setup* and *start*\n Kibana Platform life-cycles for ease-of-use on server-side and browser-side.\n4. `ExpressionsService` creates a bound version of all exported contract functions.\n5. Functions are bound the way there are:\n\n ```ts\n registerFunction = (...args: Parameters\n ): ReturnType => this.executor.registerFunction(...args);\n ```\n\n so that JSDoc appears in developers IDE when they use those `plugins.expressions.registerFunction(`."],"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionsService","text":"ExpressionsService"}," implements ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.PersistableStateService","text":"PersistableStateService"},"<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},">"],"children":[{"id":"def-public.ExpressionsService.executor","type":"Object","label":"executor","description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":175,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L175"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Executor","text":"Executor"},">"]},{"id":"def-public.ExpressionsService.renderers","type":"Object","label":"renderers","description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":176,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L176"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRendererRegistry","text":"ExpressionRendererRegistry"}]},{"id":"def-public.ExpressionsService.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"{\n executor = Executor.createWithDefaults(),\n renderers = new ExpressionRendererRegistry(),\n }","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionServiceParams","text":"ExpressionServiceParams"}],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":178,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L178"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":178,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L178"}},{"id":"def-public.ExpressionsService.registerFunction","type":"Function","children":[{"type":"CompoundType","label":"functionDefinition","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"},")"],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":219,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L219"}}],"signature":["(functionDefinition: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"},")) => void"],"description":["\nRegister an expression function, which will be possible to execute as\npart of the expression pipeline.\n\nBelow we register a function which simply sleeps for given number of\nmilliseconds to delay the execution and outputs its input as-is.\n\n```ts\nexpressions.registerFunction({\n name: 'sleep',\n args: {\n time: {\n aliases: ['_'],\n help: 'Time in milliseconds for how long to sleep',\n types: ['number'],\n },\n },\n help: '',\n fn: async (input, args, context) => {\n await new Promise(r => setTimeout(r, args.time));\n return input;\n },\n}\n```\n\nThe actual function is defined in the `fn` key. The function can be *async*.\nIt receives three arguments: (1) `input` is the output of the previous function\nor the initial input of the expression if the function is first in chain;\n(2) `args` are function arguments as defined in expression string, that can\nbe edited by user (e.g in case of Canvas); (3) `context` is a shared object\npassed to all functions that can be used for side-effects."],"label":"registerFunction","source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":218,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L218"},"returnComment":[]},{"id":"def-public.ExpressionsService.registerType","type":"Function","children":[{"type":"CompoundType","label":"typeDefinition","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"},")"],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":223,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L223"}}],"signature":["(typeDefinition: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"},")) => void"],"description":[],"label":"registerType","source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":222,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L222"},"returnComment":[]},{"id":"def-public.ExpressionsService.registerRenderer","type":"Function","children":[{"type":"CompoundType","label":"definition","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionRenderDefinition","text":"AnyExpressionRenderDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionRenderDefinition","text":"AnyExpressionRenderDefinition"},")"],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":227,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L227"}}],"signature":["(definition: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionRenderDefinition","text":"AnyExpressionRenderDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionRenderDefinition","text":"AnyExpressionRenderDefinition"},")) => void"],"description":[],"label":"registerRenderer","source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":226,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L226"},"returnComment":[]},{"id":"def-public.ExpressionsService.run","type":"Function","children":[{"type":"CompoundType","label":"ast","isRequired":true,"signature":["string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":230,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L230"}},{"type":"Uncategorized","label":"input","isRequired":true,"signature":["Input"],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":230,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L230"}},{"type":"Object","label":"params","isRequired":false,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionExecutionParams","text":"ExpressionExecutionParams"}," | undefined"],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":230,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L230"}}],"signature":["(ast: string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},", input: Input, params: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionExecutionParams","text":"ExpressionExecutionParams"}," | undefined) => Promise"],"description":[],"label":"run","source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":230,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L230"},"returnComment":[]},{"id":"def-public.ExpressionsService.getFunction","type":"Function","children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":233,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L233"}}],"signature":["(name: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"}," | undefined"],"description":[],"label":"getFunction","source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":233,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L233"},"returnComment":[]},{"id":"def-public.ExpressionsService.getFunctions","type":"Function","children":[],"signature":["() => Record"],"description":["\nReturns POJO map of all registered expression functions, where keys are\nnames of the functions and values are `ExpressionFunction` instances."],"label":"getFunctions","source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":240,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L240"},"returnComment":[]},{"id":"def-public.ExpressionsService.getRenderer","type":"Function","children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":243,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L243"}}],"signature":["(name: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRenderer","text":"ExpressionRenderer"}," | null"],"description":[],"label":"getRenderer","source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":243,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L243"},"returnComment":[]},{"id":"def-public.ExpressionsService.getRenderers","type":"Function","children":[],"signature":["() => Record>"],"description":["\nReturns POJO map of all registered expression renderers, where keys are\nnames of the renderers and values are `ExpressionRenderer` instances."],"label":"getRenderers","source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":250,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L250"},"returnComment":[]},{"id":"def-public.ExpressionsService.getType","type":"Function","children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":253,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L253"}}],"signature":["(name: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionType","text":"ExpressionType"}," | undefined"],"description":[],"label":"getType","source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":253,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L253"},"returnComment":[]},{"id":"def-public.ExpressionsService.getTypes","type":"Function","children":[],"signature":["() => Record"],"description":["\nReturns POJO map of all registered expression types, where keys are\nnames of the types and values are `ExpressionType` instances."],"label":"getTypes","source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":260,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L260"},"returnComment":[]},{"id":"def-public.ExpressionsService.execute","type":"Function","label":"execute","description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":262,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L262"},"signature":["(ast: string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},", input: Input, params?: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionExecutionParams","text":"ExpressionExecutionParams"}," | undefined) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContract","text":"ExecutionContract"},""]},{"id":"def-public.ExpressionsService.fork","type":"Function","children":[],"signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionsService","text":"ExpressionsService"}],"description":[],"label":"fork","source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":268,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L268"},"returnComment":[]},{"id":"def-public.ExpressionsService.telemetry","type":"Function","children":[{"type":"Object","label":"state","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":281,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L281"}},{"type":"Object","label":"telemetryData","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":282,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L282"}}],"signature":["(state: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},", telemetryData?: Record) => Record"],"description":["\nExtracts telemetry from expression AST"],"label":"telemetry","source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":280,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L280"},"returnComment":[]},{"id":"def-public.ExpressionsService.extract","type":"Function","children":[{"type":"Object","label":"state","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":292,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L292"}}],"signature":["(state: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},") => { state: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},"; references: ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[]; }"],"description":["\nExtracts saved object references from expression AST"],"label":"extract","source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":292,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L292"},"returnComment":["new expression AST with references removed and array of references"]},{"id":"def-public.ExpressionsService.inject","type":"Function","children":[{"type":"Object","label":"state","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":302,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L302"}},{"type":"Array","label":"references","isRequired":true,"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[]"],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":302,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L302"}}],"signature":["(state: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},", references: ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[]) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":["\nInjects saved object references into expression AST"],"label":"inject","source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":302,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L302"},"returnComment":["new expression AST with references injected"]},{"id":"def-public.ExpressionsService.migrate","type":"Function","children":[{"type":"Object","label":"state","isRequired":true,"signature":[{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.SerializableState","text":"SerializableState"}],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":312,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L312"}},{"type":"string","label":"version","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":312,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L312"}}],"signature":["(state: ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},", version: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":["\nRuns the migration (if it exists) for specified version. This will run a single migration step (ie from 7.10.0 to 7.10.1)"],"label":"migrate","source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":312,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L312"},"returnComment":["new migrated expression AST"]},{"id":"def-public.ExpressionsService.setup","type":"Function","label":"setup","signature":["() => Pick<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionsService","text":"ExpressionsService"},", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">"],"description":["\nReturns Kibana Platform *setup* life-cycle contract. Useful to return the\nsame contract on server-side and browser-side."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":320,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L320"}},{"id":"def-public.ExpressionsService.start","type":"Function","label":"start","signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionsServiceStart","text":"ExpressionsServiceStart"}],"description":["\nReturns Kibana Platform *start* life-cycle contract. Useful to return the\nsame contract on server-side and browser-side."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":328,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L328"}},{"id":"def-public.ExpressionsService.stop","type":"Function","label":"stop","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":332,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L332"}}],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":174,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L174"},"initialIsOpen":false},{"id":"def-public.TablesAdapter","type":"Class","label":"TablesAdapter","description":[],"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.TablesAdapter","text":"TablesAdapter"}," extends ","EventEmitter"],"children":[{"id":"def-public.TablesAdapter.logDatatable","type":"Function","label":"logDatatable","signature":["(name: string, datatable: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"},") => void"],"description":[],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/util/tables_adapter.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/tables_adapter.ts#L15"}},{"type":"Object","label":"datatable","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"}],"description":[],"source":{"path":"src/plugins/expressions/common/util/tables_adapter.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/tables_adapter.ts#L15"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/util/tables_adapter.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/tables_adapter.ts#L15"}},{"id":"def-public.TablesAdapter.tables","type":"Object","label":"tables","description":[],"source":{"path":"src/plugins/expressions/common/util/tables_adapter.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/tables_adapter.ts#L20"},"signature":["{ [key: string]: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"},"; }"]}],"source":{"path":"src/plugins/expressions/common/util/tables_adapter.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/tables_adapter.ts#L12"},"initialIsOpen":false},{"id":"def-public.ExpressionsInspectorAdapter","type":"Class","label":"ExpressionsInspectorAdapter","description":[],"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionsInspectorAdapter","text":"ExpressionsInspectorAdapter"}," extends ","EventEmitter"],"children":[{"id":"def-public.ExpressionsInspectorAdapter.logAST","type":"Function","label":"logAST","signature":["(ast: any) => void"],"description":[],"children":[{"type":"Any","label":"ast","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/util/expressions_inspector_adapter.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/expressions_inspector_adapter.ts#L14"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/util/expressions_inspector_adapter.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/expressions_inspector_adapter.ts#L14"}},{"id":"def-public.ExpressionsInspectorAdapter.ast","type":"Any","label":"ast","description":[],"source":{"path":"src/plugins/expressions/common/util/expressions_inspector_adapter.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/expressions_inspector_adapter.ts#L19"},"signature":["any"]}],"source":{"path":"src/plugins/expressions/common/util/expressions_inspector_adapter.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/expressions_inspector_adapter.ts#L11"},"initialIsOpen":false},{"id":"def-public.ExpressionsPublicPlugin","type":"Class","label":"ExpressionsPublicPlugin","description":[],"signature":[{"pluginId":"expressions","scope":"public","docId":"kibExpressionsPluginApi","section":"def-public.ExpressionsPublicPlugin","text":"ExpressionsPublicPlugin"}," implements ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Plugin","text":"Plugin"},", ",{"pluginId":"expressions","scope":"public","docId":"kibExpressionsPluginApi","section":"def-public.ExpressionsStart","text":"ExpressionsStart"},", object, object>"],"children":[{"id":"def-public.ExpressionsPublicPlugin.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"initializerContext","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.PluginInitializerContext","text":"PluginInitializerContext"},""],"description":[],"source":{"path":"src/plugins/expressions/public/plugin.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L40"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/public/plugin.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L40"}},{"id":"def-public.ExpressionsPublicPlugin.setup","type":"Function","label":"setup","signature":["(core: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreSetup","text":"CoreSetup"},") => Pick<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionsService","text":"ExpressionsService"},", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">"],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreSetup","text":"CoreSetup"},""],"description":[],"source":{"path":"src/plugins/expressions/public/plugin.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L56"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/public/plugin.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L56"}},{"id":"def-public.ExpressionsPublicPlugin.start","type":"Function","label":"start","signature":["(core: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreStart","text":"CoreStart"},") => ",{"pluginId":"expressions","scope":"public","docId":"kibExpressionsPluginApi","section":"def-public.ExpressionsStart","text":"ExpressionsStart"}],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreStart","text":"CoreStart"}],"description":[],"source":{"path":"src/plugins/expressions/public/plugin.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L70"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/public/plugin.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L70"}},{"id":"def-public.ExpressionsPublicPlugin.stop","type":"Function","label":"stop","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/public/plugin.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L86"}}],"source":{"path":"src/plugins/expressions/public/plugin.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L37"},"initialIsOpen":false}],"functions":[{"id":"def-public.ReactExpressionRenderer","type":"Function","children":[{"type":"Object","label":"{\n className,\n dataAttrs,\n padding,\n renderError,\n expression,\n onEvent,\n onData$,\n reload$,\n debounce,\n ...expressionLoaderOptions\n}","isRequired":true,"signature":[{"pluginId":"expressions","scope":"public","docId":"kibExpressionsPluginApi","section":"def-public.ReactExpressionRendererProps","text":"ReactExpressionRendererProps"}],"description":[],"source":{"path":"src/plugins/expressions/public/react_expression_renderer.tsx","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/react_expression_renderer.tsx#L57"}}],"signature":["({ className, dataAttrs, padding, renderError, expression, onEvent, onData$, reload$, debounce, ...expressionLoaderOptions }: ",{"pluginId":"expressions","scope":"public","docId":"kibExpressionsPluginApi","section":"def-public.ReactExpressionRendererProps","text":"ReactExpressionRendererProps"},") => JSX.Element"],"description":[],"label":"ReactExpressionRenderer","source":{"path":"src/plugins/expressions/public/react_expression_renderer.tsx","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/react_expression_renderer.tsx#L57"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.buildExpression","type":"Function","label":"buildExpression","signature":["(initialState: string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}," | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstFunctionBuilder","text":"ExpressionAstFunctionBuilder"},"<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"},">[] | undefined) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpressionBuilder","text":"ExpressionAstExpressionBuilder"}],"description":["\nMakes it easy to progressively build, update, and traverse an\nexpression AST. You can either start with an empty AST, or\nprovide an expression string, AST, or array of expression\nfunction builders to use as initial state.\n"],"children":[{"type":"CompoundType","label":"initialState","isRequired":false,"signature":["string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}," | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstFunctionBuilder","text":"ExpressionAstFunctionBuilder"},"<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"},">[] | undefined"],"description":["Optional. An expression string, AST, or array of `ExpressionAstFunctionBuilder[]`."],"source":{"path":"src/plugins/expressions/common/ast/build_expression.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L98"}}],"tags":["return"],"returnComment":["`this`"],"source":{"path":"src/plugins/expressions/common/ast/build_expression.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L97"},"initialIsOpen":false},{"id":"def-public.buildExpressionFunction","type":"Function","label":"buildExpressionFunction","signature":["(fnName: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.InferFunctionDefinition","text":"InferFunctionDefinition"},"[\"name\"], initialArgs: { [K in keyof FunctionArgs]: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpressionBuilder","text":"ExpressionAstExpressionBuilder"}," | FunctionArgs[K] | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpressionBuilder","text":"ExpressionAstExpressionBuilder"},"[]; }) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstFunctionBuilder","text":"ExpressionAstFunctionBuilder"},""],"description":["\nManages an AST for a single expression function. The return value\ncan be provided to `buildExpression` to add this function to an\nexpression.\n\nNote that to preserve type safety and ensure no args are missing,\nall required arguments for the specified function must be provided\nup front. If desired, they can be changed or removed later.\n"],"children":[{"type":"Uncategorized","label":"fnName","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.InferFunctionDefinition","text":"InferFunctionDefinition"},"[\"name\"]"],"description":["String representing the name of this expression function."],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":155,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L155"}},{"type":"Object","label":"initialArgs","isRequired":true,"signature":["{ [K in keyof FunctionArgs]: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpressionBuilder","text":"ExpressionAstExpressionBuilder"}," | FunctionArgs[K] | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpressionBuilder","text":"ExpressionAstExpressionBuilder"},"[]; }"],"description":["Object containing the arguments to this function."],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":163,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L163"}}],"tags":["return"],"returnComment":["`this`"],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":152,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L152"},"initialIsOpen":false},{"id":"def-public.format","type":"Function","label":"format","signature":["(ast: T, type: T extends ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}," ? \"expression\" : \"argument\") => string"],"description":[],"children":[{"type":"Uncategorized","label":"ast","isRequired":true,"signature":["T"],"description":[],"source":{"path":"src/plugins/expressions/common/ast/format.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/format.ts#L15"}},{"type":"Uncategorized","label":"type","isRequired":true,"signature":["T extends ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}," ? \"expression\" : \"argument\""],"description":[],"source":{"path":"src/plugins/expressions/common/ast/format.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/format.ts#L16"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/ast/format.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/format.ts#L14"},"initialIsOpen":false},{"id":"def-public.formatExpression","type":"Function","label":"formatExpression","signature":["(ast: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},") => string"],"description":["\nGiven expression pipeline AST, returns formatted string.\n"],"children":[{"type":"Object","label":"ast","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":["Expression pipeline AST."],"source":{"path":"src/plugins/expressions/common/ast/format_expression.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/format_expression.ts#L17"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/ast/format_expression.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/format_expression.ts#L17"},"initialIsOpen":false},{"id":"def-public.isExpressionAstBuilder","type":"Function","label":"isExpressionAstBuilder","signature":["(val: any) => boolean"],"description":["\nType guard that checks whether a given value is an\n`ExpressionAstExpressionBuilder`. This is useful when working\nwith subexpressions, where you might be retrieving a function\nargument, and need to know whether it is an expression builder\ninstance which you can perform operations on.\n"],"children":[{"type":"Any","label":"val","isRequired":true,"signature":["any"],"description":["Value you want to check."],"source":{"path":"src/plugins/expressions/common/ast/build_expression.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L35"}}],"tags":["example","return"],"returnComment":["boolean"],"source":{"path":"src/plugins/expressions/common/ast/build_expression.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L35"},"initialIsOpen":false},{"id":"def-public.parse","type":"Function","label":"parse","signature":["(expression: E, startRule: S) => S extends \"expression\" ? ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}," : ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstArgument","text":"ExpressionAstArgument"}],"description":[],"children":[{"type":"Uncategorized","label":"expression","isRequired":true,"signature":["E"],"description":[],"source":{"path":"src/plugins/expressions/common/ast/parse.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/parse.ts#L15"}},{"type":"Uncategorized","label":"startRule","isRequired":true,"signature":["S"],"description":[],"source":{"path":"src/plugins/expressions/common/ast/parse.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/parse.ts#L16"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/ast/parse.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/parse.ts#L14"},"initialIsOpen":false},{"id":"def-public.parseExpression","type":"Function","label":"parseExpression","signature":["(expression: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":["\nGiven expression pipeline string, returns parsed AST.\n"],"children":[{"type":"string","label":"expression","isRequired":true,"signature":["string"],"description":["Expression pipeline string."],"source":{"path":"src/plugins/expressions/common/ast/parse_expression.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/parse_expression.ts#L17"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/ast/parse_expression.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/parse_expression.ts#L17"},"initialIsOpen":false}],"interfaces":[{"id":"def-public.ExpressionExecutor","type":"Interface","label":"ExpressionExecutor","description":[],"children":[{"id":"def-public.ExpressionExecutor.interpreter","type":"Object","label":"interpreter","description":[],"source":{"path":"src/plugins/expressions/public/types/index.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L25"},"signature":[{"pluginId":"expressions","scope":"public","docId":"kibExpressionsPluginApi","section":"def-public.ExpressionInterpreter","text":"ExpressionInterpreter"}]}],"source":{"path":"src/plugins/expressions/public/types/index.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L24"},"initialIsOpen":false},{"id":"def-public.IExpressionLoaderParams","type":"Interface","label":"IExpressionLoaderParams","description":[],"children":[{"id":"def-public.IExpressionLoaderParams.searchContext","type":"Object","label":"searchContext","description":[],"source":{"path":"src/plugins/expressions/public/types/index.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L36"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined"]},{"id":"def-public.IExpressionLoaderParams.context","type":"Any","label":"context","description":[],"source":{"path":"src/plugins/expressions/public/types/index.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L37"},"signature":["any"]},{"id":"def-public.IExpressionLoaderParams.variables","type":"Object","label":"variables","description":[],"source":{"path":"src/plugins/expressions/public/types/index.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L38"},"signature":["Record | undefined"]},{"id":"def-public.IExpressionLoaderParams.debug","type":"CompoundType","label":"debug","description":[],"source":{"path":"src/plugins/expressions/public/types/index.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L40"},"signature":["boolean | undefined"]},{"id":"def-public.IExpressionLoaderParams.disableCaching","type":"CompoundType","label":"disableCaching","description":[],"source":{"path":"src/plugins/expressions/public/types/index.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L41"},"signature":["boolean | undefined"]},{"id":"def-public.IExpressionLoaderParams.customFunctions","type":"Object","label":"customFunctions","description":[],"source":{"path":"src/plugins/expressions/public/types/index.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L42"},"signature":["[] | undefined"]},{"id":"def-public.IExpressionLoaderParams.customRenderers","type":"Object","label":"customRenderers","description":[],"source":{"path":"src/plugins/expressions/public/types/index.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L43"},"signature":["[] | undefined"]},{"id":"def-public.IExpressionLoaderParams.uiState","type":"Unknown","label":"uiState","description":[],"source":{"path":"src/plugins/expressions/public/types/index.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L44"},"signature":["unknown"]},{"id":"def-public.IExpressionLoaderParams.inspectorAdapters","type":"Object","label":"inspectorAdapters","description":[],"source":{"path":"src/plugins/expressions/public/types/index.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L45"},"signature":[{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"}," | undefined"]},{"id":"def-public.IExpressionLoaderParams.onRenderError","type":"Function","label":"onRenderError","description":[],"source":{"path":"src/plugins/expressions/public/types/index.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L46"},"signature":[{"pluginId":"expressions","scope":"public","docId":"kibExpressionsPluginApi","section":"def-public.RenderErrorHandlerFnType","text":"RenderErrorHandlerFnType"}," | undefined"]},{"id":"def-public.IExpressionLoaderParams.searchSessionId","type":"string","label":"searchSessionId","description":[],"source":{"path":"src/plugins/expressions/public/types/index.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L47"},"signature":["string | undefined"]},{"id":"def-public.IExpressionLoaderParams.renderMode","type":"CompoundType","label":"renderMode","description":[],"source":{"path":"src/plugins/expressions/public/types/index.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L48"},"signature":["\"display\" | \"noInteractivity\" | \"edit\" | \"preview\" | undefined"]},{"id":"def-public.IExpressionLoaderParams.syncColors","type":"CompoundType","label":"syncColors","description":[],"source":{"path":"src/plugins/expressions/public/types/index.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L49"},"signature":["boolean | undefined"]},{"id":"def-public.IExpressionLoaderParams.hasCompatibleActions","type":"Function","label":"hasCompatibleActions","description":[],"source":{"path":"src/plugins/expressions/public/types/index.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L50"},"signature":["((event: ",{"pluginId":"expressions","scope":"public","docId":"kibExpressionsPluginApi","section":"def-public.ExpressionRendererEvent","text":"ExpressionRendererEvent"},") => Promise) | undefined"]}],"source":{"path":"src/plugins/expressions/public/types/index.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L35"},"initialIsOpen":false},{"id":"def-public.ExpressionRenderError","type":"Interface","label":"ExpressionRenderError","signature":[{"pluginId":"expressions","scope":"public","docId":"kibExpressionsPluginApi","section":"def-public.ExpressionRenderError","text":"ExpressionRenderError"}," extends Error"],"description":[],"children":[{"id":"def-public.ExpressionRenderError.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/expressions/public/types/index.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L54"},"signature":["string | undefined"]},{"id":"def-public.ExpressionRenderError.original","type":"Object","label":"original","description":[],"source":{"path":"src/plugins/expressions/public/types/index.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L55"},"signature":["Error | undefined"]}],"source":{"path":"src/plugins/expressions/public/types/index.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/types/index.ts#L53"},"initialIsOpen":false},{"id":"def-public.ReactExpressionRendererProps","type":"Interface","label":"ReactExpressionRendererProps","signature":[{"pluginId":"expressions","scope":"public","docId":"kibExpressionsPluginApi","section":"def-public.ReactExpressionRendererProps","text":"ReactExpressionRendererProps"}," extends ",{"pluginId":"expressions","scope":"public","docId":"kibExpressionsPluginApi","section":"def-public.IExpressionLoaderParams","text":"IExpressionLoaderParams"}],"description":[],"children":[{"id":"def-public.ReactExpressionRendererProps.className","type":"string","label":"className","description":[],"source":{"path":"src/plugins/expressions/public/react_expression_renderer.tsx","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/react_expression_renderer.tsx#L24"},"signature":["string | undefined"]},{"id":"def-public.ReactExpressionRendererProps.dataAttrs","type":"Array","label":"dataAttrs","description":[],"source":{"path":"src/plugins/expressions/public/react_expression_renderer.tsx","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/react_expression_renderer.tsx#L25"},"signature":["string[] | undefined"]},{"id":"def-public.ReactExpressionRendererProps.expression","type":"CompoundType","label":"expression","description":[],"source":{"path":"src/plugins/expressions/public/react_expression_renderer.tsx","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/react_expression_renderer.tsx#L26"},"signature":["string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}]},{"id":"def-public.ReactExpressionRendererProps.renderError","type":"Function","label":"renderError","description":[],"source":{"path":"src/plugins/expressions/public/react_expression_renderer.tsx","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/react_expression_renderer.tsx#L27"},"signature":["((message?: string | null | undefined, error?: ",{"pluginId":"expressions","scope":"public","docId":"kibExpressionsPluginApi","section":"def-public.ExpressionRenderError","text":"ExpressionRenderError"}," | null | undefined) => React.ReactElement React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)> | React.ReactElement React.ReactElement React.Component)> | null) | (new (props: any) => React.Component)>[]) | undefined"]},{"id":"def-public.ReactExpressionRendererProps.padding","type":"CompoundType","label":"padding","description":[],"source":{"path":"src/plugins/expressions/public/react_expression_renderer.tsx","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/react_expression_renderer.tsx#L31"},"signature":["\"m\" | \"s\" | \"l\" | \"xs\" | \"xl\" | undefined"]},{"id":"def-public.ReactExpressionRendererProps.onEvent","type":"Function","label":"onEvent","description":[],"source":{"path":"src/plugins/expressions/public/react_expression_renderer.tsx","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/react_expression_renderer.tsx#L32"},"signature":["((event: ",{"pluginId":"expressions","scope":"public","docId":"kibExpressionsPluginApi","section":"def-public.ExpressionRendererEvent","text":"ExpressionRendererEvent"},") => void) | undefined"]},{"id":"def-public.ReactExpressionRendererProps.onData$","type":"Function","label":"onData$","description":[],"source":{"path":"src/plugins/expressions/public/react_expression_renderer.tsx","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/react_expression_renderer.tsx#L33"},"signature":["((data: TData, adapters?: TInspectorAdapters | undefined) => void) | undefined"]},{"id":"def-public.ReactExpressionRendererProps.reload$","type":"Object","label":"reload$","description":["\nAn observable which can be used to re-run the expression without destroying the component"],"source":{"path":"src/plugins/expressions/public/react_expression_renderer.tsx","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/react_expression_renderer.tsx#L37"},"signature":["Observable"," | undefined"]},{"id":"def-public.ReactExpressionRendererProps.debounce","type":"number","label":"debounce","description":[],"source":{"path":"src/plugins/expressions/public/react_expression_renderer.tsx","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/react_expression_renderer.tsx#L38"},"signature":["number | undefined"]}],"source":{"path":"src/plugins/expressions/public/react_expression_renderer.tsx","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/react_expression_renderer.tsx#L23"},"initialIsOpen":false},{"id":"def-public.ExpressionRendererEvent","type":"Interface","label":"ExpressionRendererEvent","description":[],"children":[{"id":"def-public.ExpressionRendererEvent.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/public/render.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L28"}},{"id":"def-public.ExpressionRendererEvent.data","type":"Any","label":"data","description":[],"source":{"path":"src/plugins/expressions/public/render.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L29"},"signature":["any"]}],"source":{"path":"src/plugins/expressions/public/render.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/render.ts#L27"},"initialIsOpen":false},{"id":"def-public.Datatable","type":"Interface","label":"Datatable","description":["\nA `Datatable` in Canvas is a unique structure that represents tabulated data."],"children":[{"id":"def-public.Datatable.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L99"},"signature":["\"datatable\""]},{"id":"def-public.Datatable.columns","type":"Array","label":"columns","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":100,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L100"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.DatatableColumn","text":"DatatableColumn"},"[]"]},{"id":"def-public.Datatable.rows","type":"Array","label":"rows","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L101"},"signature":["Record[]"]}],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L98"},"initialIsOpen":false},{"id":"def-public.DatatableColumn","type":"Interface","label":"DatatableColumn","description":["\nThis type represents the shape of a column in a `Datatable`."],"children":[{"id":"def-public.DatatableColumn.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L90"}},{"id":"def-public.DatatableColumn.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":91,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L91"}},{"id":"def-public.DatatableColumn.meta","type":"Object","label":"meta","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L92"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.DatatableColumnMeta","text":"DatatableColumnMeta"}]}],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L89"},"initialIsOpen":false},{"id":"def-public.ExecutionContext","type":"Interface","label":"ExecutionContext","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},""],"description":["\n`ExecutionContext` is an object available to all functions during a single execution;\nit provides various methods to perform side-effects."],"children":[{"id":"def-public.ExecutionContext.getSearchContext","type":"Function","label":"getSearchContext","description":["\nGet search context of the expression."],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L28"},"signature":["() => ExecutionContextSearch"]},{"id":"def-public.ExecutionContext.variables","type":"Object","label":"variables","description":["\nContext variables that can be consumed using `var` and `var_set` functions."],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L33"},"signature":["Record"]},{"id":"def-public.ExecutionContext.types","type":"Object","label":"types","description":["\nA map of available expression types."],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L38"},"signature":["Record"]},{"id":"def-public.ExecutionContext.abortSignal","type":"Object","label":"abortSignal","description":["\nAdds ability to abort current execution."],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L43"},"signature":["AbortSignal"]},{"id":"def-public.ExecutionContext.inspectorAdapters","type":"Uncategorized","label":"inspectorAdapters","description":["\nAdapters for `inspector` plugin."],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L48"},"signature":["InspectorAdapters"]},{"id":"def-public.ExecutionContext.getSearchSessionId","type":"Function","label":"getSearchSessionId","description":["\nSearch context in which expression should operate."],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L53"},"signature":["() => string | undefined"]},{"id":"def-public.ExecutionContext.getKibanaRequest","type":"Function","label":"getKibanaRequest","description":["\nGetter to retrieve the `KibanaRequest` object inside an expression function.\nUseful for functions which are running on the server and need to perform\noperations that are scoped to a specific user."],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L60"},"signature":["(() => ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},") | undefined"]},{"id":"def-public.ExecutionContext.getSavedObject","type":"Function","label":"getSavedObject","description":["\nAllows to fetch saved objects from ElasticSearch. In browser `getSavedObject`\nfunction is provided automatically by the Expressions plugin. On the server\nthe caller of the expression has to provide this context function. The\nreason is because on the browser we always know the user who tries to\nfetch a saved object, thus saved object client is scoped automatically to\nthat user. However, on the server we can scope that saved object client to\nany user, or even not scope it at all and execute it as an \"internal\" user."],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L71"},"signature":["((type: string, id: string) => Promise<",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},">) | undefined"]},{"id":"def-public.ExecutionContext.isSyncColorsEnabled","type":"Function","label":"isSyncColorsEnabled","description":["\nReturns the state (true|false) of the sync colors across panels switch."],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L79"},"signature":["(() => boolean) | undefined"]}],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L21"},"initialIsOpen":false},{"id":"def-public.ExecutionParams","type":"Interface","label":"ExecutionParams","description":[],"children":[{"id":"def-public.ExecutionParams.executor","type":"Object","label":"executor","description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L58"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Executor","text":"Executor"},""]},{"id":"def-public.ExecutionParams.ast","type":"Object","label":"ast","description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L59"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}," | undefined"]},{"id":"def-public.ExecutionParams.expression","type":"string","label":"expression","description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L60"},"signature":["string | undefined"]},{"id":"def-public.ExecutionParams.params","type":"Object","label":"params","description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L61"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionExecutionParams","text":"ExpressionExecutionParams"}]}],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L57"},"initialIsOpen":false},{"id":"def-public.ExecutionState","type":"Interface","label":"ExecutionState","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionState","text":"ExecutionState"}," extends ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"},">"],"description":[],"children":[{"id":"def-public.ExecutionState.ast","type":"Object","label":"ast","description":[],"source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L18"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}]},{"id":"def-public.ExecutionState.state","type":"CompoundType","label":"state","description":["\nTracks state of execution.\n\n- `not-started` - before .start() method was called.\n- `pending` - immediately after .start() method is called.\n- `result` - when expression execution completed.\n- `error` - when execution failed with error."],"source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L28"},"signature":["\"result\" | \"error\" | \"not-started\" | \"pending\""]},{"id":"def-public.ExecutionState.result","type":"Uncategorized","label":"result","description":["\nResult of the expression execution."],"source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L33"},"signature":["Output | undefined"]},{"id":"def-public.ExecutionState.error","type":"Object","label":"error","description":["\nError happened during the execution."],"source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L38"},"signature":["Error | undefined"]}],"source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L17"},"initialIsOpen":false},{"id":"def-public.ExecutorState","type":"Interface","label":"ExecutorState","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"},""],"description":[],"children":[{"id":"def-public.ExecutorState.functions","type":"Object","label":"functions","description":[],"source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L17"},"signature":["Record"]},{"id":"def-public.ExecutorState.types","type":"Object","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L18"},"signature":["Record"]},{"id":"def-public.ExecutorState.context","type":"Uncategorized","label":"context","description":[],"source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L19"},"signature":["Context"]}],"source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L16"},"initialIsOpen":false},{"id":"def-public.ExpressionAstExpressionBuilder","type":"Interface","label":"ExpressionAstExpressionBuilder","description":[],"children":[{"id":"def-public.ExpressionAstExpressionBuilder.type","type":"string","label":"type","description":["\nUsed to identify expression builder objects."],"source":{"path":"src/plugins/expressions/common/ast/build_expression.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L48"},"signature":["\"expression_builder\""]},{"id":"def-public.ExpressionAstExpressionBuilder.functions","type":"Array","label":"functions","description":["\nArray of each of the `buildExpressionFunction()` instances\nin this expression. Use this to remove or reorder functions\nin the expression."],"source":{"path":"src/plugins/expressions/common/ast/build_expression.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L54"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstFunctionBuilder","text":"ExpressionAstFunctionBuilder"},"<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"},">[]"]},{"id":"def-public.ExpressionAstExpressionBuilder.findFunction","type":"Function","label":"findFunction","description":["\nRecursively searches expression for all ocurrences of the\nfunction, including in subexpressions.\n\nUseful when performing migrations on a specific function,\nas you can iterate over the array of references and update\nall functions at once.\n"],"source":{"path":"src/plugins/expressions/common/ast/build_expression.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L66"},"signature":["(fnName: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.InferFunctionDefinition","text":"InferFunctionDefinition"},"[\"name\"]) => [] | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstFunctionBuilder","text":"ExpressionAstFunctionBuilder"},"[]"]},{"id":"def-public.ExpressionAstExpressionBuilder.toAst","type":"Function","label":"toAst","description":["\nConverts expression to an AST.\n"],"source":{"path":"src/plugins/expressions/common/ast/build_expression.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L74"},"signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}]},{"id":"def-public.ExpressionAstExpressionBuilder.toString","type":"Function","label":"toString","description":["\nConverts expression to an expression string.\n"],"source":{"path":"src/plugins/expressions/common/ast/build_expression.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L80"},"signature":["() => string"]}],"source":{"path":"src/plugins/expressions/common/ast/build_expression.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L44"},"initialIsOpen":false},{"id":"def-public.ExpressionAstFunctionBuilder","type":"Interface","label":"ExpressionAstFunctionBuilder","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstFunctionBuilder","text":"ExpressionAstFunctionBuilder"},""],"description":[],"children":[{"id":"def-public.ExpressionAstFunctionBuilder.type","type":"string","label":"type","description":["\nUsed to identify expression function builder objects."],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L63"},"signature":["\"expression_function_builder\""]},{"id":"def-public.ExpressionAstFunctionBuilder.name","type":"Uncategorized","label":"name","description":["\nName of this expression function."],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L67"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.InferFunctionDefinition","text":"InferFunctionDefinition"},"[\"name\"]"]},{"id":"def-public.ExpressionAstFunctionBuilder.arguments","type":"Object","label":"arguments","description":["\nObject of all args currently added to the function. This is\nstructured similarly to `ExpressionAstFunction['arguments']`,\nhowever any subexpressions are returned as expression builder\ninstances instead of expression ASTs."],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L74"},"signature":["FunctionBuilderArguments"]},{"id":"def-public.ExpressionAstFunctionBuilder.addArgument","type":"Function","label":"addArgument","description":["\nAdds an additional argument to the function. For multi-args,\nthis should be called once for each new arg. Note that TS\nwill not enforce whether multi-args are available, so only\nuse this to update an existing arg if you are certain it\nis a multi-arg.\n"],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L86"},"signature":[">(name: A, value: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpressionBuilder","text":"ExpressionAstExpressionBuilder"}," | FunctionArgs[A]) => this"]},{"id":"def-public.ExpressionAstFunctionBuilder.getArgument","type":"Function","label":"getArgument","description":["\nRetrieves an existing argument by name.\nUseful when you want to retrieve the current array of args and add\nsomething to it before calling `replaceArgument`. Any subexpression\narguments will be returned as expression builder instances.\n"],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L99"},"signature":[">(name: A) => (",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpressionBuilder","text":"ExpressionAstExpressionBuilder"}," | FunctionArgs[A])[] | undefined"]},{"id":"def-public.ExpressionAstFunctionBuilder.replaceArgument","type":"Function","label":"replaceArgument","description":["\nOverwrites an existing argument with a new value.\nIn order to support multi-args, the value given must always be\nan array.\n"],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":111,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L111"},"signature":[">(name: A, value: (",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpressionBuilder","text":"ExpressionAstExpressionBuilder"}," | FunctionArgs[A])[]) => this"]},{"id":"def-public.ExpressionAstFunctionBuilder.removeArgument","type":"Function","label":"removeArgument","description":["\nRemoves an (optional) argument from the function.\n\nTypeScript will enforce that you only remove optional\narguments. For manipulating required args, use `replaceArgument`.\n"],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":124,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L124"},"signature":[">>(name: A) => this"]},{"id":"def-public.ExpressionAstFunctionBuilder.toAst","type":"Function","label":"toAst","description":["\nConverts function to an AST.\n"],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":130,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L130"},"signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstFunction","text":"ExpressionAstFunction"}]},{"id":"def-public.ExpressionAstFunctionBuilder.toString","type":"Function","label":"toString","description":["\nConverts function to an expression string.\n"],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":136,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L136"},"signature":["() => string"]}],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L57"},"initialIsOpen":false},{"id":"def-public.ExpressionFunctionDefinition","type":"Interface","label":"ExpressionFunctionDefinition","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunctionDefinition","text":"ExpressionFunctionDefinition"}," extends Partial<",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.PersistableState","text":"PersistableState"},">>"],"description":["\n`ExpressionFunctionDefinition` is the interface plugins have to implement to\nregister a function in `expressions` plugin."],"children":[{"id":"def-public.ExpressionFunctionDefinition.name","type":"Uncategorized","label":"name","description":["\nThe name of the function, as will be used in expression."],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L40"},"signature":["Name"]},{"id":"def-public.ExpressionFunctionDefinition.disabled","type":"CompoundType","label":"disabled","description":["\nif set to true function will be disabled (but its migrate function will still be available)"],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L45"},"signature":["boolean | undefined"]},{"id":"def-public.ExpressionFunctionDefinition.type","type":"CompoundType","label":"type","description":["\nName of type of value this function outputs."],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L50"},"signature":["\"date\" | \"filter\" | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.KnownTypeToString","text":"KnownTypeToString"},"<","UnwrapPromiseOrReturn","> | undefined"]},{"id":"def-public.ExpressionFunctionDefinition.inputTypes","type":"Array","label":"inputTypes","description":["\nList of allowed type names for input value of this function. If this\nproperty is set the input of function will be cast to the first possible\ntype in this list. If this property is missing the input will be provided\nto the function as-is."],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L58"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.TypeToString","text":"TypeToString"},"[] | undefined"]},{"id":"def-public.ExpressionFunctionDefinition.args","type":"Object","label":"args","description":["\nSpecification of arguments that function supports. This list will also be\nused for autocomplete functionality when your function is being edited."],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L64"},"signature":["{ [key in keyof Arguments]: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ArgumentType","text":"ArgumentType"},"; }"]},{"id":"def-public.ExpressionFunctionDefinition.aliases","type":"Array","label":"aliases","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L69"},"signature":["string[] | undefined"]},{"id":"def-public.ExpressionFunctionDefinition.help","type":"string","label":"help","description":["\nHelp text displayed in the Expression editor. This text should be\ninternationalized."],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L75"}},{"id":"def-public.ExpressionFunctionDefinition.fn","type":"Function","label":"fn","signature":["(input: Input, args: Arguments, context: Context) => Output"],"description":["\nThe actual implementation of the function.\n"],"children":[{"type":"Uncategorized","label":"input","isRequired":true,"signature":["Input"],"description":["Output of the previous function, or initial input."],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L86"}},{"type":"Uncategorized","label":"args","isRequired":true,"signature":["Arguments"],"description":["Parameters set for this function in expression."],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L86"}},{"type":"Uncategorized","label":"context","isRequired":true,"signature":["Context"],"description":["Object with functions to perform side effects. This object\nis created for the duration of the execution of expression and is the\nsame for all functions in expression chain."],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L86"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L86"}},{"id":"def-public.ExpressionFunctionDefinition.context","type":"Object","label":"context","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":91,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L91"},"signature":["{ types: any[] | undefined; } | undefined"]}],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L30"},"initialIsOpen":false},{"id":"def-public.ExpressionFunctionDefinitions","type":"Interface","label":"ExpressionFunctionDefinitions","description":["\nA mapping of `ExpressionFunctionDefinition`s for functions which the\nExpressions services provides out-of-the-box. Any new functions registered\nby the Expressions plugin should have their types added here.\n"],"children":[{"id":"def-public.ExpressionFunctionDefinitions.clog","type":"Object","label":"clog","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":117,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L117"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunctionClog","text":"ExpressionFunctionClog"}]},{"id":"def-public.ExpressionFunctionDefinitions.font","type":"Object","label":"font","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":118,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L118"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunctionFont","text":"ExpressionFunctionFont"}]},{"id":"def-public.ExpressionFunctionDefinitions.var_set","type":"Object","label":"var_set","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":119,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L119"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunctionVarSet","text":"ExpressionFunctionVarSet"}]},{"id":"def-public.ExpressionFunctionDefinitions.var","type":"Object","label":"var","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":120,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L120"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunctionVar","text":"ExpressionFunctionVar"}]},{"id":"def-public.ExpressionFunctionDefinitions.theme","type":"Object","label":"theme","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":121,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L121"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunctionTheme","text":"ExpressionFunctionTheme"}]},{"id":"def-public.ExpressionFunctionDefinitions.cumulative_sum","type":"Object","label":"cumulative_sum","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":122,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L122"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunctionCumulativeSum","text":"ExpressionFunctionCumulativeSum"}]},{"id":"def-public.ExpressionFunctionDefinitions.derivative","type":"Object","label":"derivative","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":123,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L123"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunctionDerivative","text":"ExpressionFunctionDerivative"}]},{"id":"def-public.ExpressionFunctionDefinitions.moving_average","type":"Object","label":"moving_average","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":124,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L124"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunctionMovingAverage","text":"ExpressionFunctionMovingAverage"}]}],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L116"},"initialIsOpen":false},{"id":"def-public.ExpressionImage","type":"Interface","label":"ExpressionImage","description":[],"children":[{"id":"def-public.ExpressionImage.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/image.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L15"},"signature":["\"image\""]},{"id":"def-public.ExpressionImage.mode","type":"string","label":"mode","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/image.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L16"}},{"id":"def-public.ExpressionImage.dataurl","type":"string","label":"dataurl","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/image.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L17"}}],"source":{"path":"src/plugins/expressions/common/expression_types/specs/image.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L14"},"initialIsOpen":false},{"id":"def-public.ExpressionRenderDefinition","type":"Interface","label":"ExpressionRenderDefinition","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRenderDefinition","text":"ExpressionRenderDefinition"},""],"description":[],"children":[{"id":"def-public.ExpressionRenderDefinition.name","type":"string","label":"name","description":["\nTechnical name of the renderer, used as ID to identify renderer in\nexpression renderer registry. This must match the name of the expression\nfunction that is used to create the `type: render` object."],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L15"}},{"id":"def-public.ExpressionRenderDefinition.displayName","type":"string","label":"displayName","description":["\nA user friendly name of the renderer as will be displayed to user in UI."],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L20"},"signature":["string | undefined"]},{"id":"def-public.ExpressionRenderDefinition.help","type":"string","label":"help","description":["\nHelp text as will be displayed to user. A sentence or few about what this\nelement does."],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L26"},"signature":["string | undefined"]},{"id":"def-public.ExpressionRenderDefinition.validate","type":"Function","label":"validate","description":["\nUsed to validate the data before calling the render function."],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L31"},"signature":["(() => Error | undefined) | undefined"]},{"id":"def-public.ExpressionRenderDefinition.reuseDomNode","type":"boolean","label":"reuseDomNode","description":["\nTell the renderer if the dom node should be reused, it's recreated each\ntime by default."],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L37"}},{"id":"def-public.ExpressionRenderDefinition.render","type":"Function","label":"render","description":["\nThe function called to render the output data of an expression."],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L42"},"signature":["(domNode: HTMLElement, config: Config, handlers: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.IInterpreterRenderHandlers","text":"IInterpreterRenderHandlers"},") => void | Promise"]}],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L9"},"initialIsOpen":false},{"id":"def-public.ExpressionTypeDefinition","type":"Interface","label":"ExpressionTypeDefinition","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionTypeDefinition","text":"ExpressionTypeDefinition"},""],"description":["\nA generic type which represents a custom Expression Type Definition that's\nregistered to the Interpreter."],"children":[{"id":"def-public.ExpressionTypeDefinition.name","type":"Uncategorized","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L31"},"signature":["Name"]},{"id":"def-public.ExpressionTypeDefinition.validate","type":"Function","label":"validate","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L32"},"signature":["((type: any) => void | Error) | undefined"]},{"id":"def-public.ExpressionTypeDefinition.serialize","type":"Function","label":"serialize","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L33"},"signature":["((type: Value) => SerializedType) | undefined"]},{"id":"def-public.ExpressionTypeDefinition.deserialize","type":"Function","label":"deserialize","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L34"},"signature":["((type: SerializedType) => Value) | undefined"]},{"id":"def-public.ExpressionTypeDefinition.from","type":"Object","label":"from","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L37"},"signature":["{ [type: string]: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueConverter","text":"ExpressionValueConverter"},"; } | undefined"]},{"id":"def-public.ExpressionTypeDefinition.to","type":"Object","label":"to","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L40"},"signature":["{ [type: string]: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueConverter","text":"ExpressionValueConverter"},"; } | undefined"]},{"id":"def-public.ExpressionTypeDefinition.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L43"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L26"},"initialIsOpen":false},{"id":"def-public.ExpressionTypeStyle","type":"Interface","label":"ExpressionTypeStyle","description":["\nAn object that represents style information, typically CSS."],"children":[{"id":"def-public.ExpressionTypeStyle.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":121,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L121"},"signature":["\"style\""]},{"id":"def-public.ExpressionTypeStyle.spec","type":"Object","label":"spec","description":[],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":122,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L122"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.CSSStyle","text":"CSSStyle"}]},{"id":"def-public.ExpressionTypeStyle.css","type":"string","label":"css","description":[],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":123,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L123"}}],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":120,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L120"},"initialIsOpen":false},{"id":"def-public.Font","type":"Interface","label":"Font","description":["\nAn interface representing a font in Canvas, with a textual label and the CSS\n`font-value`."],"children":[{"id":"def-public.Font.label","type":"CompoundType","label":"label","description":[],"source":{"path":"src/plugins/expressions/common/fonts.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L26"},"signature":["\"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Lucida Grande\" | \"Myriad\" | \"Open Sans\" | \"Optima\" | \"Palatino\""]},{"id":"def-public.Font.value","type":"CompoundType","label":"value","description":[],"source":{"path":"src/plugins/expressions/common/fonts.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L27"},"signature":["\"'American Typewriter', 'Courier New', Courier, Monaco, mono\" | \"Arial, sans-serif\" | \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Brush Script MT', 'Comic Sans', sans-serif\" | \"Chalkboard, 'Comic Sans', sans-serif\" | \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"Futura, Impact, Helvetica, Arial, sans-serif\" | \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"'Helvetica Neue', Helvetica, Arial, sans-serif\" | \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\" | \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\" | \"Myriad, Helvetica, Arial, sans-serif\" | \"'Open Sans', Helvetica, Arial, sans-serif\" | \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\""]}],"source":{"path":"src/plugins/expressions/common/fonts.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L25"},"initialIsOpen":false},{"id":"def-public.IInterpreterRenderHandlers","type":"Interface","label":"IInterpreterRenderHandlers","description":[],"children":[{"id":"def-public.IInterpreterRenderHandlers.done","type":"Function","label":"done","description":["\nDone increments the number of rendering successes"],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L67"},"signature":["() => void"]},{"id":"def-public.IInterpreterRenderHandlers.onDestroy","type":"Function","label":"onDestroy","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L68"},"signature":["(fn: () => void) => void"]},{"id":"def-public.IInterpreterRenderHandlers.reload","type":"Function","label":"reload","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L69"},"signature":["() => void"]},{"id":"def-public.IInterpreterRenderHandlers.update","type":"Function","label":"update","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L70"},"signature":["(params: any) => void"]},{"id":"def-public.IInterpreterRenderHandlers.event","type":"Function","label":"event","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L71"},"signature":["(event: any) => void"]},{"id":"def-public.IInterpreterRenderHandlers.hasCompatibleActions","type":"Function","label":"hasCompatibleActions","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L72"},"signature":["((event: any) => Promise) | undefined"]},{"id":"def-public.IInterpreterRenderHandlers.getRenderMode","type":"Function","label":"getRenderMode","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L73"},"signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.RenderMode","text":"RenderMode"}]},{"id":"def-public.IInterpreterRenderHandlers.isSyncColorsEnabled","type":"Function","label":"isSyncColorsEnabled","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L74"},"signature":["() => boolean"]},{"id":"def-public.IInterpreterRenderHandlers.uiState","type":"Unknown","label":"uiState","description":["\nThis uiState interface is actually `PersistedState` from the visualizations plugin,\nbut expressions cannot know about vis or it creates a mess of circular dependencies.\nDownstream consumers of the uiState handler will need to cast for now."],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L80"},"signature":["unknown"]}],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L63"},"initialIsOpen":false},{"id":"def-public.IRegistry","type":"Interface","label":"IRegistry","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.IRegistry","text":"IRegistry"},""],"description":[],"children":[{"id":"def-public.IRegistry.get","type":"Function","label":"get","signature":["(id: string) => T | null"],"description":[],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/types/registry.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/registry.ts#L10"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/types/registry.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/registry.ts#L10"}},{"id":"def-public.IRegistry.toJS","type":"Function","label":"toJS","signature":["() => Record"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/types/registry.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/registry.ts#L12"}},{"id":"def-public.IRegistry.toArray","type":"Function","label":"toArray","signature":["() => T[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/types/registry.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/registry.ts#L14"}}],"source":{"path":"src/plugins/expressions/common/types/registry.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/registry.ts#L9"},"initialIsOpen":false},{"id":"def-public.PointSeriesColumn","type":"Interface","label":"PointSeriesColumn","description":["\nColumn in a PointSeries"],"children":[{"id":"def-public.PointSeriesColumn.type","type":"CompoundType","label":"type","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L24"},"signature":["\"string\" | \"number\""]},{"id":"def-public.PointSeriesColumn.role","type":"CompoundType","label":"role","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L25"},"signature":["\"measure\" | \"dimension\""]},{"id":"def-public.PointSeriesColumn.expression","type":"string","label":"expression","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L26"}}],"source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L23"},"initialIsOpen":false},{"id":"def-public.Range","type":"Interface","label":"Range","description":[],"children":[{"id":"def-public.Range.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/range.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L15"},"signature":["\"range\""]},{"id":"def-public.Range.from","type":"number","label":"from","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/range.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L16"}},{"id":"def-public.Range.to","type":"number","label":"to","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/range.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L17"}},{"id":"def-public.Range.label","type":"string","label":"label","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/range.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L18"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/expressions/common/expression_types/specs/range.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L14"},"initialIsOpen":false},{"id":"def-public.SerializedDatatable","type":"Interface","label":"SerializedDatatable","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializedDatatable","text":"SerializedDatatable"}," extends ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"}],"description":[],"children":[{"id":"def-public.SerializedDatatable.rows","type":"Array","label":"rows","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":105,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L105"},"signature":["string[][]"]}],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L104"},"initialIsOpen":false},{"id":"def-public.SerializedFieldFormat","type":"Interface","label":"SerializedFieldFormat","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializedFieldFormat","text":"SerializedFieldFormat"},""],"description":["\nJSON representation of a field formatter configuration.\nIs used to carry information about how to format data in\na data table as part of the column definition."],"children":[{"id":"def-public.SerializedFieldFormat.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/expressions/common/types/common.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L54"},"signature":["string | undefined"]},{"id":"def-public.SerializedFieldFormat.params","type":"Uncategorized","label":"params","description":[],"source":{"path":"src/plugins/expressions/common/types/common.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L55"},"signature":["TParams | undefined"]}],"source":{"path":"src/plugins/expressions/common/types/common.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L53"},"initialIsOpen":false},{"id":"def-public.ExpressionsServiceStart","type":"Interface","label":"ExpressionsServiceStart","description":["\nThe public contract that `ExpressionsService` provides to other plugins\nin Kibana Platform in *start* life-cycle."],"children":[{"id":"def-public.ExpressionsServiceStart.getFunction","type":"Function","label":"getFunction","description":["\nGet a registered `ExpressionFunction` by its name, which was registered\nusing the `registerFunction` method. The returned `ExpressionFunction`\ninstance is an internal representation of the function in Expressions\nservice - do not mutate that object."],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L78"},"signature":["(name: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"}," | undefined"]},{"id":"def-public.ExpressionsServiceStart.getRenderer","type":"Function","label":"getRenderer","description":["\nGet a registered `ExpressionRenderer` by its name, which was registered\nusing the `registerRenderer` method. The returned `ExpressionRenderer`\ninstance is an internal representation of the renderer in Expressions\nservice - do not mutate that object."],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L86"},"signature":["(name: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRenderer","text":"ExpressionRenderer"}," | null"]},{"id":"def-public.ExpressionsServiceStart.getType","type":"Function","label":"getType","description":["\nGet a registered `ExpressionType` by its name, which was registered\nusing the `registerType` method. The returned `ExpressionType`\ninstance is an internal representation of the type in Expressions\nservice - do not mutate that object."],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L94"},"signature":["(name: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionType","text":"ExpressionType"}," | undefined"]},{"id":"def-public.ExpressionsServiceStart.run","type":"Function","label":"run","description":["\nExecutes expression string or a parsed expression AST and immediately\nreturns the result.\n\nBelow example will execute `sleep 100 | clog` expression with `123` initial\ninput to the first function.\n\n```ts\nexpressions.run('sleep 100 | clog', 123);\n```\n\n- `sleep 100` will delay execution by 100 milliseconds and pass the `123` input as\n its output.\n- `clog` will print to console `123` and pass it as its output.\n- The final result of the execution will be `123`.\n\nOptionally, you can pass an object as the third argument which will be used\nto extend the `ExecutionContext`—an object passed to each function\nas the third argument, that allows functions to perform side-effects.\n\n```ts\nexpressions.run('...', null, { elasticsearchClient });\n```"],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":120,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L120"},"signature":["(ast: string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},", input: Input, params?: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionExecutionParams","text":"ExpressionExecutionParams"}," | undefined) => Promise"]},{"id":"def-public.ExpressionsServiceStart.execute","type":"Function","label":"execute","description":["\nStarts expression execution and immediately returns `ExecutionContract`\ninstance that tracks the progress of the execution and can be used to\ninteract with the execution."],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L131"},"signature":["(ast: string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},", input: Input, params?: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionExecutionParams","text":"ExpressionExecutionParams"}," | undefined) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContract","text":"ExecutionContract"},""]},{"id":"def-public.ExpressionsServiceStart.fork","type":"Function","label":"fork","description":["\nCreate a new instance of `ExpressionsService`. The new instance inherits\nall state of the original `ExpressionsService`, including all expression\ntypes, expression functions and context. Also, all new types and functions\nregistered in the original services AFTER the forking event will be\navailable in the forked instance. However, all new types and functions\nregistered in the forked instances will NOT be available to the original\nservice."],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":147,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L147"},"signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionsService","text":"ExpressionsService"}]}],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L71"},"initialIsOpen":false}],"enums":[{"id":"def-public.FontStyle","type":"Enum","label":"FontStyle","description":["\nEnum of supported CSS `font-style` properties."],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L35"},"initialIsOpen":false},{"id":"def-public.FontWeight","type":"Enum","label":"FontWeight","description":["\nEnum of supported CSS `font-weight` properties."],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L43"},"initialIsOpen":false},{"id":"def-public.Overflow","type":"Enum","label":"Overflow","description":["\nEnum of supported CSS `overflow` properties."],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L62"},"initialIsOpen":false},{"id":"def-public.TextAlignment","type":"Enum","label":"TextAlignment","description":["\nEnum of supported CSS `text-align` properties."],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L72"},"initialIsOpen":false},{"id":"def-public.TextDecoration","type":"Enum","label":"TextDecoration","description":["\nEnum of supported CSS `text-decoration` properties."],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L82"},"initialIsOpen":false}],"misc":[{"id":"def-public.ExpressionRendererComponent","type":"Type","label":"ExpressionRendererComponent","description":[],"source":{"path":"src/plugins/expressions/public/react_expression_renderer.tsx","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/react_expression_renderer.tsx#L49"},"signature":["(props: React.PropsWithChildren<",{"pluginId":"expressions","scope":"public","docId":"kibExpressionsPluginApi","section":"def-public.ReactExpressionRendererProps","text":"ReactExpressionRendererProps"},">, context: any) => React.ReactElement | null"],"initialIsOpen":false},{"id":"def-public.ReactExpressionRendererType","type":"Type","label":"ReactExpressionRendererType","description":[],"source":{"path":"src/plugins/expressions/public/react_expression_renderer.tsx","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/react_expression_renderer.tsx#L41"},"signature":["React.ComponentClass<",{"pluginId":"expressions","scope":"public","docId":"kibExpressionsPluginApi","section":"def-public.ReactExpressionRendererProps","text":"ReactExpressionRendererProps"},", any> | React.FunctionComponent<",{"pluginId":"expressions","scope":"public","docId":"kibExpressionsPluginApi","section":"def-public.ReactExpressionRendererProps","text":"ReactExpressionRendererProps"},">"],"initialIsOpen":false},{"id":"def-public.AnyExpressionFunctionDefinition","type":"Type","label":"AnyExpressionFunctionDefinition","description":["\nType to capture every possible expression function definition."],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L102"},"signature":["ExpressionFunctionDefinition, any, ExecutionContext<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},">>"],"initialIsOpen":false},{"id":"def-public.AnyExpressionTypeDefinition","type":"Type","label":"AnyExpressionTypeDefinition","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L46"},"signature":["ExpressionTypeDefinition"],"initialIsOpen":false},{"id":"def-public.ArgumentType","type":"Type","label":"ArgumentType","description":["\nThis type represents all of the possible combinations of properties of an\nArgument in an Expression Function. The presence or absence of certain fields\ninfluence the shape and presence of others within each `arg` in the specification."],"source":{"path":"src/plugins/expressions/common/expression_functions/arguments.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/arguments.ts#L16"},"signature":["SingleArgumentType | MultipleArgumentType | UnresolvedSingleArgumentType | UnresolvedMultipleArgumentType"],"initialIsOpen":false},{"id":"def-public.DatatableColumnType","type":"Type","label":"DatatableColumnType","description":["\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES"],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L36"},"signature":["\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\""],"initialIsOpen":false},{"id":"def-public.DatatableRow","type":"Type","label":"DatatableRow","description":["\nThis type represents a row in a `Datatable`."],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L57"},"signature":["{ [x: string]: any; }"],"initialIsOpen":false},{"id":"def-public.ExecutionContainer","type":"Type","label":"ExecutionContainer","description":[],"source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L73"},"signature":["StateContainer, ExecutionPureTransitions, {}>"],"initialIsOpen":false},{"id":"def-public.ExecutorContainer","type":"Type","label":"ExecutorContainer","description":[],"source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L55"},"signature":["StateContainer, ExecutorPureTransitions, ExecutorPureSelectors>"],"initialIsOpen":false},{"id":"def-public.ExpressionAstArgument","type":"Type","label":"ExpressionAstArgument","description":[],"source":{"path":"src/plugins/expressions/common/ast/types.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/types.ts#L77"},"signature":["string | number | false | true | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"initialIsOpen":false},{"id":"def-public.ExpressionAstExpression","type":"Type","label":"ExpressionAstExpression","description":[],"source":{"path":"src/plugins/expressions/common/ast/types.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/types.ts#L16"},"signature":["{ type: 'expression'; chain: ExpressionAstFunction[]; }"],"initialIsOpen":false},{"id":"def-public.ExpressionAstFunction","type":"Type","label":"ExpressionAstFunction","description":[],"source":{"path":"src/plugins/expressions/common/ast/types.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/types.ts#L21"},"signature":["{ type: 'function'; function: string; arguments: Record; debug?: ExpressionAstFunctionDebug | undefined; }"],"initialIsOpen":false},{"id":"def-public.ExpressionAstNode","type":"Type","label":"ExpressionAstNode","description":[],"source":{"path":"src/plugins/expressions/common/ast/types.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/types.ts#L11"},"signature":["string | number | false | true | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstFunction","text":"ExpressionAstFunction"}," | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"initialIsOpen":false},{"id":"def-public.ExpressionValue","type":"Type","label":"ExpressionValue","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L15"},"signature":["any"],"initialIsOpen":false},{"id":"def-public.ExpressionValueBoxed","type":"Type","label":"ExpressionValueBoxed","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L11"},"signature":["{ type: Type; } & Value"],"initialIsOpen":false},{"id":"def-public.ExpressionValueConverter","type":"Type","label":"ExpressionValueConverter","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L17"},"signature":["(input: I, availableTypes: Record) => O"],"initialIsOpen":false},{"id":"def-public.ExpressionValueError","type":"Type","label":"ExpressionValueError","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/error.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/error.ts#L17"},"signature":["{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }"],"initialIsOpen":false},{"id":"def-public.ExpressionValueNum","type":"Type","label":"ExpressionValueNum","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/num.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L14"},"signature":["{ type: \"num\"; } & { value: number; }"],"initialIsOpen":false},{"id":"def-public.ExpressionValueRender","type":"Type","label":"ExpressionValueRender","description":["\nRepresents an object that is intended to be rendered."],"source":{"path":"src/plugins/expressions/common/expression_types/specs/render.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/render.ts#L16"},"signature":["{ type: \"render\"; } & { as: string; value: T; }"],"initialIsOpen":false},{"id":"def-public.ExpressionValueUnboxed","type":"Type","label":"ExpressionValueUnboxed","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L9"},"signature":["any"],"initialIsOpen":false},{"id":"def-public.ExpressionValueFilter","type":"Type","label":"ExpressionValueFilter","description":["\nRepresents an object that is a Filter."],"source":{"path":"src/plugins/expressions/common/expression_types/specs/filter.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/filter.ts#L14"},"signature":["{ type: \"filter\"; } & { filterType?: string | undefined; value?: string | undefined; column?: string | undefined; and: ExpressionValueFilter[]; to?: string | undefined; from?: string | undefined; query?: string | null | undefined; }"],"initialIsOpen":false},{"id":"def-public.FontLabel","type":"Type","label":"FontLabel","description":["\nThis type contains a unions of all supported font labels, or the the name of\nthe font the user would see in a UI."],"source":{"path":"src/plugins/expressions/common/fonts.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L13"},"signature":["\"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Lucida Grande\" | \"Myriad\" | \"Open Sans\" | \"Optima\" | \"Palatino\""],"initialIsOpen":false},{"id":"def-public.FontValue","type":"Type","label":"FontValue","description":["\nThis type contains a union of all supported font values, equivalent to the CSS\n`font-value` property."],"source":{"path":"src/plugins/expressions/common/fonts.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L19"},"signature":["\"'American Typewriter', 'Courier New', Courier, Monaco, mono\" | \"Arial, sans-serif\" | \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Brush Script MT', 'Comic Sans', sans-serif\" | \"Chalkboard, 'Comic Sans', sans-serif\" | \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"Futura, Impact, Helvetica, Arial, sans-serif\" | \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"'Helvetica Neue', Helvetica, Arial, sans-serif\" | \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\" | \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\" | \"Myriad, Helvetica, Arial, sans-serif\" | \"'Open Sans', Helvetica, Arial, sans-serif\" | \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\""],"initialIsOpen":false},{"id":"def-public.InterpreterErrorType","type":"Type","label":"InterpreterErrorType","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/error.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/error.ts#L33"},"signature":["{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }"],"initialIsOpen":false},{"id":"def-public.KnownTypeToString","type":"Type","label":"KnownTypeToString","description":["\nMap the type of the generic to a string-based representation of the type.\n\nIf the provided generic is its own type interface, we use the value of\nthe `type` key as a string literal type for it."],"source":{"path":"src/plugins/expressions/common/types/common.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L26"},"signature":["T extends string ? \"string\" : T extends boolean ? \"boolean\" : T extends number ? \"number\" : T extends null ? \"null\" : T extends { type: string; } ? T[\"type\"] : never"],"initialIsOpen":false},{"id":"def-public.PointSeries","type":"Type","label":"PointSeries","description":["\nA `PointSeries` is a unique structure that represents dots on a chart."],"source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L39"},"signature":["{ type: \"pointseries\"; } & { columns: PointSeriesColumns; rows: PointSeriesRow[]; }"],"initialIsOpen":false},{"id":"def-public.PointSeriesColumnName","type":"Type","label":"PointSeriesColumnName","description":["\nAllowed column names in a PointSeries"],"source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L18"},"signature":["\"color\" | \"y\" | \"x\" | \"text\" | \"size\""],"initialIsOpen":false},{"id":"def-public.PointSeriesColumns","type":"Type","label":"PointSeriesColumns","description":["\nRepresents a collection of valid Columns in a PointSeries"],"source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L32"},"signature":["{} | Record<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.PointSeriesColumnName","text":"PointSeriesColumnName"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.PointSeriesColumn","text":"PointSeriesColumn"},">"],"initialIsOpen":false},{"id":"def-public.PointSeriesRow","type":"Type","label":"PointSeriesRow","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L34"},"signature":["{ [x: string]: any; }"],"initialIsOpen":false},{"id":"def-public.Style","type":"Type","label":"Style","description":[],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":126,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L126"},"signature":["ExpressionTypeStyle"],"initialIsOpen":false},{"id":"def-public.TypeString","type":"Type","label":"TypeString","description":["\nIf the type extends a Promise, we still need to return the string representation:\n\n`someArgument: Promise` results in `types: ['boolean', 'string']`"],"source":{"path":"src/plugins/expressions/common/types/common.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L39"},"signature":["UnwrapPromiseOrReturn extends string ? \"string\" : UnwrapPromiseOrReturn extends boolean ? \"boolean\" : UnwrapPromiseOrReturn extends number ? \"number\" : UnwrapPromiseOrReturn extends null ? \"null\" : UnwrapPromiseOrReturn extends { type: string; } ? ({ type: string; } & UnwrapPromiseOrReturn)[\"type\"] : never"],"initialIsOpen":false},{"id":"def-public.TypeToString","type":"Type","label":"TypeToString","description":["\nThis can convert a type into a known Expression string representation of\nthat type. For example, `TypeToString` will resolve to `'datatable'`.\nThis allows Expression Functions to continue to specify their type in a\nsimple string format."],"source":{"path":"src/plugins/expressions/common/types/common.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L17"},"signature":["\"date\" | \"filter\" | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.KnownTypeToString","text":"KnownTypeToString"},""],"initialIsOpen":false},{"id":"def-public.UnmappedTypeStrings","type":"Type","label":"UnmappedTypeStrings","description":["\nTypes used in Expressions that don't map to a primitive cleanly:\n\n`date` is typed as a number or string, and represents a date"],"source":{"path":"src/plugins/expressions/common/types/common.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L46"},"signature":["\"date\" | \"filter\""],"initialIsOpen":false},{"id":"def-public.ExpressionValueRender","type":"Type","label":"ExpressionValueRender","description":["\nRepresents an object that is intended to be rendered."],"source":{"path":"src/plugins/expressions/common/expression_types/specs/render.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/render.ts#L16"},"signature":["{ type: \"render\"; } & { as: string; value: T; }"],"initialIsOpen":false}],"objects":[],"setup":{"id":"def-public.ExpressionsSetup","type":"Type","label":"ExpressionsSetup","description":["\nExpressions public setup contract, extends {@link ExpressionsServiceSetup}"],"source":{"path":"src/plugins/expressions/public/plugin.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L24"},"signature":["{ readonly getType: (name: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionType","text":"ExpressionType"}," | undefined; readonly getFunction: (name: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"}," | undefined; readonly getFunctions: () => Record; readonly getRenderer: (name: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRenderer","text":"ExpressionRenderer"}," | null; readonly getRenderers: () => Record JSX.Element"]},{"id":"def-public.ExpressionsStart.render","type":"Function","label":"render","description":[],"source":{"path":"src/plugins/expressions/public/plugin.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L34"},"signature":["typeof ",{"pluginId":"expressions","scope":"public","docId":"kibExpressionsPluginApi","section":"def-public.render","text":"render"}]}],"source":{"path":"src/plugins/expressions/public/plugin.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/public/plugin.ts#L29"},"lifecycle":"start","initialIsOpen":true}},"server":{"classes":[{"id":"def-server.ExpressionsServerPlugin","type":"Class","label":"ExpressionsServerPlugin","description":[],"signature":[{"pluginId":"expressions","scope":"server","docId":"kibExpressionsPluginApi","section":"def-server.ExpressionsServerPlugin","text":"ExpressionsServerPlugin"}," implements ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.Plugin","text":"Plugin"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionsServiceStart","text":"ExpressionsServiceStart"},", object, object>"],"children":[{"id":"def-server.ExpressionsServerPlugin.expressions","type":"Object","label":"expressions","description":[],"source":{"path":"src/plugins/expressions/server/plugin.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L18"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionsService","text":"ExpressionsService"}]},{"id":"def-server.ExpressionsServerPlugin.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"initializerContext","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.PluginInitializerContext","text":"PluginInitializerContext"},""],"description":[],"source":{"path":"src/plugins/expressions/server/plugin.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L20"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/server/plugin.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L20"}},{"id":"def-server.ExpressionsServerPlugin.setup","type":"Function","label":"setup","signature":["(core: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreSetup","text":"CoreSetup"},") => Pick<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionsService","text":"ExpressionsService"},", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">"],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreSetup","text":"CoreSetup"},""],"description":[],"source":{"path":"src/plugins/expressions/server/plugin.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L22"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/server/plugin.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L22"}},{"id":"def-server.ExpressionsServerPlugin.start","type":"Function","label":"start","signature":["(core: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreStart","text":"CoreStart"},") => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionsServiceStart","text":"ExpressionsServiceStart"}],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreStart","text":"CoreStart"}],"description":[],"source":{"path":"src/plugins/expressions/server/plugin.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L32"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/server/plugin.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L32"}},{"id":"def-server.ExpressionsServerPlugin.stop","type":"Function","label":"stop","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/server/plugin.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L38"}}],"source":{"path":"src/plugins/expressions/server/plugin.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L16"},"initialIsOpen":false},{"id":"def-server.Execution","type":"Class","label":"Execution","description":[],"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Execution","text":"Execution"},""],"children":[{"id":"def-server.Execution.state","type":"Object","label":"state","description":["\nDynamic state of the execution."],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L80"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContainer","text":"ExecutionContainer"},">"]},{"id":"def-server.Execution.input","type":"Uncategorized","label":"input","description":["\nInitial input of the execution.\n\nN.B. It is initialized to `null` rather than `undefined` for legacy reasons,\nbecause in legacy interpreter it was set to `null` by default."],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L88"},"signature":["Input"]},{"id":"def-server.Execution.context","type":"Object","label":"context","description":["\nExecution context - object that allows to do side-effects. Context is passed\nto every function."],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L94"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},""]},{"id":"def-server.Execution.contract","type":"Object","label":"contract","description":["\nContract is a public representation of `Execution` instances. Contract we\ncan return to other plugins for their consumption."],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":134,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L134"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContract","text":"ExecutionContract"},""]},{"id":"def-server.Execution.expression","type":"string","label":"expression","description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":140,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L140"}},{"id":"def-server.Execution.result","type":"Object","label":"result","description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":142,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L142"},"signature":["Promise>"]},{"id":"def-server.Execution.inspectorAdapters","type":"Uncategorized","label":"inspectorAdapters","description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":146,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L146"},"signature":["InspectorAdapters"]},{"id":"def-server.Execution.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"execution","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionParams","text":"ExecutionParams"}],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":150,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L150"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":150,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L150"}},{"id":"def-server.Execution.cancel","type":"Function","label":"cancel","signature":["() => void"],"description":["\nStop execution of expression."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":192,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L192"}},{"id":"def-server.Execution.start","type":"Function","label":"start","signature":["(input?: Input) => void"],"description":["\nCall this method to start execution.\n\nN.B. `input` is initialized to `null` rather than `undefined` for legacy reasons,\nbecause in legacy interpreter it was set to `null` by default."],"children":[{"type":"Uncategorized","label":"input","isRequired":true,"signature":["Input"],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":202,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L202"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":202,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L202"}},{"id":"def-server.Execution.invokeChain","type":"Function","label":"invokeChain","signature":["(chainArr: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstFunction","text":"ExpressionAstFunction"},"[], input: unknown) => Promise"],"description":[],"children":[{"type":"Array","label":"chainArr","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstFunction","text":"ExpressionAstFunction"},"[]"],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":236,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L236"}},{"type":"Unknown","label":"input","isRequired":true,"signature":["unknown"],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":236,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L236"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":236,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L236"}},{"id":"def-server.Execution.invokeFunction","type":"Function","label":"invokeFunction","signature":["(fn: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"},", input: unknown, args: Record) => Promise"],"description":[],"children":[{"type":"Object","label":"fn","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"}],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":317,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L317"}},{"type":"Unknown","label":"input","isRequired":true,"signature":["unknown"],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":318,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L318"}},{"type":"Object","label":"args","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":319,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L319"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":316,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L316"}},{"id":"def-server.Execution.cast","type":"Function","label":"cast","signature":["(value: any, toTypeNames?: string[] | undefined) => any"],"description":[],"children":[{"type":"Any","label":"value","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":348,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L348"}},{"type":"Array","label":"toTypeNames","isRequired":false,"signature":["string[] | undefined"],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":348,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L348"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":348,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L348"}},{"id":"def-server.Execution.resolveArgs","type":"Function","label":"resolveArgs","signature":["(fnDef: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"},", input: unknown, argAsts: any) => Promise"],"description":[],"children":[{"type":"Object","label":"fnDef","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"}],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":374,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L374"}},{"type":"Unknown","label":"input","isRequired":true,"signature":["unknown"],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":374,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L374"}},{"type":"Any","label":"argAsts","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":374,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L374"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":374,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L374"}},{"id":"def-server.Execution.interpret","type":"Function","label":"interpret","signature":["(ast: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstNode","text":"ExpressionAstNode"},", input: T) => Promise"],"description":[],"children":[{"type":"CompoundType","label":"ast","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstNode","text":"ExpressionAstNode"}],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":465,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L465"}},{"type":"Uncategorized","label":"input","isRequired":true,"signature":["T"],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":465,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L465"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":465,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L465"}}],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L70"},"initialIsOpen":false},{"id":"def-server.Executor","type":"Class","label":"Executor","description":[],"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Executor","text":"Executor"}," implements ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.PersistableStateService","text":"PersistableStateService"},"<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},">"],"children":[{"id":"def-server.Executor.createWithDefaults","type":"Function","label":"createWithDefaults","signature":["typeof ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Executor","text":"Executor"},".createWithDefaults"],"description":[],"children":[{"type":"Object","label":"state","isRequired":false,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"}," | undefined"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L83"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L82"}},{"id":"def-server.Executor.state","type":"Object","label":"state","description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":91,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L91"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorContainer","text":"ExecutorContainer"},""]},{"id":"def-server.Executor.functions","type":"Object","label":"functions","description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L96"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.FunctionsRegistry","text":"FunctionsRegistry"}]},{"id":"def-server.Executor.types","type":"Object","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L101"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.TypesRegistry","text":"TypesRegistry"}]},{"id":"def-server.Executor.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"state","isRequired":false,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"}," | undefined"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L103"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L103"}},{"id":"def-server.Executor.registerFunction","type":"Function","label":"registerFunction","signature":["(functionDefinition: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"},")) => void"],"description":[],"children":[{"type":"CompoundType","label":"functionDefinition","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"},")"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L110"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":109,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L109"}},{"id":"def-server.Executor.getFunction","type":"Function","label":"getFunction","signature":["(name: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"}," | undefined"],"description":[],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":118,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L118"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":118,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L118"}},{"id":"def-server.Executor.getFunctions","type":"Function","label":"getFunctions","signature":["() => Record"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":122,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L122"}},{"id":"def-server.Executor.registerType","type":"Function","label":"registerType","signature":["(typeDefinition: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"},")) => void"],"description":[],"children":[{"type":"CompoundType","label":"typeDefinition","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"},")"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":127,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L127"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":126,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L126"}},{"id":"def-server.Executor.getType","type":"Function","label":"getType","signature":["(name: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionType","text":"ExpressionType"}," | undefined"],"description":[],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":135,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L135"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":135,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L135"}},{"id":"def-server.Executor.getTypes","type":"Function","label":"getTypes","signature":["() => Record"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":139,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L139"}},{"id":"def-server.Executor.extendContext","type":"Function","label":"extendContext","signature":["(extraContext: Record) => void"],"description":[],"children":[{"type":"Object","label":"extraContext","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":143,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L143"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":143,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L143"}},{"id":"def-server.Executor.context","type":"Object","label":"context","description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":147,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L147"},"signature":["Record"]},{"id":"def-server.Executor.run","type":"Function","label":"run","signature":["(ast: string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},", input: Input, params?: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionExecutionParams","text":"ExpressionExecutionParams"},") => Promise"],"description":["\nExecute expression and return result.\n"],"children":[{"type":"CompoundType","label":"ast","isRequired":true,"signature":["string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":["Expression AST or a string representing expression."],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":160,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L160"}},{"type":"Uncategorized","label":"input","isRequired":true,"signature":["Input"],"description":["Initial input to the first expression function."],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":161,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L161"}},{"type":"Object","label":"params","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionExecutionParams","text":"ExpressionExecutionParams"}],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":162,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L162"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":159,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L159"}},{"id":"def-server.Executor.createExecution","type":"Function","label":"createExecution","signature":["(ast: string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},", params?: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionExecutionParams","text":"ExpressionExecutionParams"},") => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Execution","text":"Execution"},""],"description":[],"children":[{"type":"CompoundType","label":"ast","isRequired":true,"signature":["string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":170,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L170"}},{"type":"Object","label":"params","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionExecutionParams","text":"ExpressionExecutionParams"}],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":171,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L171"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":169,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L169"}},{"id":"def-server.Executor.inject","type":"Function","label":"inject","signature":["(ast: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},", references: ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[]) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":[],"children":[{"type":"Object","label":"ast","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":217,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L217"}},{"type":"Array","label":"references","isRequired":true,"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[]"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":217,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L217"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":217,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L217"}},{"id":"def-server.Executor.extract","type":"Function","label":"extract","signature":["(ast: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},") => { state: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},"; references: ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[]; }"],"description":[],"children":[{"type":"Object","label":"ast","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":223,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L223"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":223,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L223"}},{"id":"def-server.Executor.telemetry","type":"Function","label":"telemetry","signature":["(ast: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},", telemetryData: Record) => Record"],"description":[],"children":[{"type":"Object","label":"ast","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":233,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L233"}},{"type":"Object","label":"telemetryData","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":233,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L233"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":233,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L233"}},{"id":"def-server.Executor.migrate","type":"Function","label":"migrate","signature":["(ast: ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},", version: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":[],"children":[{"type":"Object","label":"ast","isRequired":true,"signature":[{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.SerializableState","text":"SerializableState"}],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":241,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L241"}},{"type":"string","label":"version","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":241,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L241"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":241,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L241"}},{"id":"def-server.Executor.fork","type":"Function","label":"fork","signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Executor","text":"Executor"},""],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":250,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L250"}}],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L80"},"initialIsOpen":false},{"id":"def-server.ExpressionFunction","type":"Class","label":"ExpressionFunction","description":[],"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"}," implements ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.PersistableState","text":"PersistableState"},">"],"children":[{"id":"def-server.ExpressionFunction.name","type":"string","label":"name","description":["\nName of function"],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L22"}},{"id":"def-server.ExpressionFunction.aliases","type":"Array","label":"aliases","description":["\nAliases that can be used instead of `name`."],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L27"},"signature":["string[]"]},{"id":"def-server.ExpressionFunction.type","type":"string","label":"type","description":["\nReturn type of function. This SHOULD be supplied. We use it for UI\nand autocomplete hinting. We may also use it for optimizations in\nthe future."],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L34"}},{"id":"def-server.ExpressionFunction.fn","type":"Function","label":"fn","description":["\nFunction to run function (context, args)"],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L39"},"signature":["(input: any, params: Record, handlers: object) => any"]},{"id":"def-server.ExpressionFunction.help","type":"string","label":"help","description":["\nA short help text."],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L44"}},{"id":"def-server.ExpressionFunction.args","type":"Object","children":[],"description":["\nSpecification of expression function parameters."],"label":"args","source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L49"}},{"id":"def-server.ExpressionFunction.inputTypes","type":"Array","label":"inputTypes","description":["\nType of inputs that this function supports."],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L54"},"signature":["string[] | undefined"]},{"id":"def-server.ExpressionFunction.disabled","type":"boolean","label":"disabled","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L56"}},{"id":"def-server.ExpressionFunction.telemetry","type":"Function","label":"telemetry","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L57"},"signature":["(state: Record, telemetryData: Record) => Record"]},{"id":"def-server.ExpressionFunction.extract","type":"Function","label":"extract","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L61"},"signature":["(state: Record) => { state: Record; references: ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[]; }"]},{"id":"def-server.ExpressionFunction.inject","type":"Function","label":"inject","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L64"},"signature":["(state: Record, references: ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[]) => Record"]},{"id":"def-server.ExpressionFunction.migrations","type":"Object","label":"migrations","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L68"},"signature":["{ [key: string]: (state: ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},") => ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},"; }"]},{"id":"def-server.ExpressionFunction.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"functionDefinition","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"}],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L72"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L72"}},{"id":"def-server.ExpressionFunction.accepts","type":"Function","children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":107,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L107"}}],"signature":["(type: string) => boolean"],"description":[],"label":"accepts","source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":107,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L107"},"returnComment":[]}],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L18"},"initialIsOpen":false},{"id":"def-server.ExpressionFunctionParameter","type":"Class","label":"ExpressionFunctionParameter","description":[],"children":[{"id":"def-server.ExpressionFunctionParameter.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L12"}},{"id":"def-server.ExpressionFunctionParameter.required","type":"boolean","label":"required","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L13"}},{"id":"def-server.ExpressionFunctionParameter.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L14"}},{"id":"def-server.ExpressionFunctionParameter.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L15"},"signature":["string[]"]},{"id":"def-server.ExpressionFunctionParameter.default","type":"Any","label":"default","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L16"},"signature":["any"]},{"id":"def-server.ExpressionFunctionParameter.aliases","type":"Array","label":"aliases","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L17"},"signature":["string[]"]},{"id":"def-server.ExpressionFunctionParameter.multi","type":"boolean","label":"multi","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L18"}},{"id":"def-server.ExpressionFunctionParameter.resolve","type":"boolean","label":"resolve","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L19"}},{"id":"def-server.ExpressionFunctionParameter.options","type":"Array","label":"options","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L20"},"signature":["any[]"]},{"id":"def-server.ExpressionFunctionParameter.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L22"}},{"type":"CompoundType","label":"arg","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ArgumentType","text":"ArgumentType"},""],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L22"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L22"}},{"id":"def-server.ExpressionFunctionParameter.accepts","type":"Function","label":"accepts","signature":["(type: string) => boolean"],"description":[],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L40"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L40"}}],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L11"},"initialIsOpen":false},{"id":"def-server.ExpressionRenderer","type":"Class","label":"ExpressionRenderer","description":[],"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRenderer","text":"ExpressionRenderer"},""],"children":[{"id":"def-server.ExpressionRenderer.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L12"}},{"id":"def-server.ExpressionRenderer.displayName","type":"string","label":"displayName","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L13"}},{"id":"def-server.ExpressionRenderer.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L14"}},{"id":"def-server.ExpressionRenderer.validate","type":"Function","label":"validate","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L15"},"signature":["() => void | Error"]},{"id":"def-server.ExpressionRenderer.reuseDomNode","type":"boolean","label":"reuseDomNode","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L16"}},{"id":"def-server.ExpressionRenderer.render","type":"Function","label":"render","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L17"},"signature":["(domNode: HTMLElement, config: Config, handlers: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.IInterpreterRenderHandlers","text":"IInterpreterRenderHandlers"},") => void | Promise"]},{"id":"def-server.ExpressionRenderer.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"config","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRenderDefinition","text":"ExpressionRenderDefinition"},""],"description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L19"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L19"}}],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L11"},"initialIsOpen":false},{"id":"def-server.ExpressionRendererRegistry","type":"Class","label":"ExpressionRendererRegistry","description":[],"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRendererRegistry","text":"ExpressionRendererRegistry"}," implements ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.IRegistry","text":"IRegistry"},"<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRenderer","text":"ExpressionRenderer"},">"],"children":[{"id":"def-server.ExpressionRendererRegistry.register","type":"Function","label":"register","signature":["(definition: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionRenderDefinition","text":"AnyExpressionRenderDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionRenderDefinition","text":"AnyExpressionRenderDefinition"},")) => void"],"description":[],"children":[{"type":"CompoundType","label":"definition","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionRenderDefinition","text":"AnyExpressionRenderDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionRenderDefinition","text":"AnyExpressionRenderDefinition"},")"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L19"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L19"}},{"id":"def-server.ExpressionRendererRegistry.get","type":"Function","label":"get","signature":["(id: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRenderer","text":"ExpressionRenderer"}," | null"],"description":[],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L25"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L25"}},{"id":"def-server.ExpressionRendererRegistry.toJS","type":"Function","label":"toJS","signature":["() => Record>"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L29"}},{"id":"def-server.ExpressionRendererRegistry.toArray","type":"Function","label":"toArray","signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRenderer","text":"ExpressionRenderer"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L39"}}],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L13"},"initialIsOpen":false},{"id":"def-server.ExpressionType","type":"Class","label":"ExpressionType","description":[],"children":[{"id":"def-server.ExpressionType.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L13"}},{"id":"def-server.ExpressionType.help","type":"string","label":"help","description":["\nA short help text."],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L18"}},{"id":"def-server.ExpressionType.validate","type":"Function","label":"validate","description":["\nType validation, useful for checking function output."],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L23"},"signature":["(type: any) => void | Error"]},{"id":"def-server.ExpressionType.create","type":"Unknown","label":"create","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L25"},"signature":["unknown"]},{"id":"def-server.ExpressionType.serialize","type":"Function","label":"serialize","description":["\nOptional serialization (used when passing context around client/server)."],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L30"},"signature":["((value: any) => any) | undefined"]},{"id":"def-server.ExpressionType.deserialize","type":"Function","label":"deserialize","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L31"},"signature":["((serialized: any) => any) | undefined"]},{"id":"def-server.ExpressionType.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"definition","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"}],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L33"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L33"}},{"id":"def-server.ExpressionType.getToFn","type":"Function","children":[{"type":"string","label":"typeName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L48"}}],"signature":["(typeName: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueConverter","text":"ExpressionValueConverter"}," | undefined"],"description":[],"label":"getToFn","source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L47"},"returnComment":[]},{"id":"def-server.ExpressionType.getFromFn","type":"Function","children":[{"type":"string","label":"typeName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L53"}}],"signature":["(typeName: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueConverter","text":"ExpressionValueConverter"}," | undefined"],"description":[],"label":"getFromFn","source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L52"},"returnComment":[]},{"id":"def-server.ExpressionType.castsTo","type":"Function","children":[{"type":"Any","label":"value","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L57"}}],"signature":["(value: any) => boolean"],"description":[],"label":"castsTo","source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L57"},"returnComment":[]},{"id":"def-server.ExpressionType.castsFrom","type":"Function","children":[{"type":"Any","label":"value","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L59"}}],"signature":["(value: any) => boolean"],"description":[],"label":"castsFrom","source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L59"},"returnComment":[]},{"id":"def-server.ExpressionType.to","type":"Function","children":[{"type":"Any","label":"value","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L61"}},{"type":"string","label":"toTypeName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L61"}},{"type":"Object","label":"types","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L61"}}],"signature":["(value: any, toTypeName: string, types: Record) => any"],"description":[],"label":"to","source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L61"},"returnComment":[]},{"id":"def-server.ExpressionType.from","type":"Function","children":[{"type":"Any","label":"value","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L73"}},{"type":"Object","label":"types","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L73"}}],"signature":["(value: any, types: Record) => any"],"description":[],"label":"from","source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L73"},"returnComment":[]}],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L12"},"initialIsOpen":false},{"id":"def-server.FunctionsRegistry","type":"Class","label":"FunctionsRegistry","description":[],"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.FunctionsRegistry","text":"FunctionsRegistry"}," implements ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.IRegistry","text":"IRegistry"},"<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"},">"],"children":[{"id":"def-server.FunctionsRegistry.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"executor","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Executor","text":"Executor"},""],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L59"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L59"}},{"id":"def-server.FunctionsRegistry.register","type":"Function","label":"register","signature":["(functionDefinition: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"},")) => void"],"description":[],"children":[{"type":"CompoundType","label":"functionDefinition","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"},")"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L62"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L61"}},{"id":"def-server.FunctionsRegistry.get","type":"Function","label":"get","signature":["(id: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"}," | null"],"description":[],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L67"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L67"}},{"id":"def-server.FunctionsRegistry.toJS","type":"Function","label":"toJS","signature":["() => Record"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L71"}},{"id":"def-server.FunctionsRegistry.toArray","type":"Function","label":"toArray","signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L75"}}],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L58"},"initialIsOpen":false},{"id":"def-server.TypesRegistry","type":"Class","label":"TypesRegistry","description":[],"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.TypesRegistry","text":"TypesRegistry"}," implements ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.IRegistry","text":"IRegistry"},"<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionType","text":"ExpressionType"},">"],"children":[{"id":"def-server.TypesRegistry.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"executor","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Executor","text":"Executor"},""],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L37"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L37"}},{"id":"def-server.TypesRegistry.register","type":"Function","label":"register","signature":["(typeDefinition: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"},")) => void"],"description":[],"children":[{"type":"CompoundType","label":"typeDefinition","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"},")"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L40"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L39"}},{"id":"def-server.TypesRegistry.get","type":"Function","label":"get","signature":["(id: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionType","text":"ExpressionType"}," | null"],"description":[],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L45"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L45"}},{"id":"def-server.TypesRegistry.toJS","type":"Function","label":"toJS","signature":["() => Record"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L49"}},{"id":"def-server.TypesRegistry.toArray","type":"Function","label":"toArray","signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionType","text":"ExpressionType"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L53"}}],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L36"},"initialIsOpen":false},{"id":"def-server.ExpressionsServerPlugin","type":"Class","label":"ExpressionsServerPlugin","description":[],"signature":[{"pluginId":"expressions","scope":"server","docId":"kibExpressionsPluginApi","section":"def-server.ExpressionsServerPlugin","text":"ExpressionsServerPlugin"}," implements ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.Plugin","text":"Plugin"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionsServiceStart","text":"ExpressionsServiceStart"},", object, object>"],"children":[{"id":"def-server.ExpressionsServerPlugin.expressions","type":"Object","label":"expressions","description":[],"source":{"path":"src/plugins/expressions/server/plugin.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L18"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionsService","text":"ExpressionsService"}]},{"id":"def-server.ExpressionsServerPlugin.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"initializerContext","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.PluginInitializerContext","text":"PluginInitializerContext"},""],"description":[],"source":{"path":"src/plugins/expressions/server/plugin.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L20"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/server/plugin.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L20"}},{"id":"def-server.ExpressionsServerPlugin.setup","type":"Function","label":"setup","signature":["(core: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreSetup","text":"CoreSetup"},") => Pick<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionsService","text":"ExpressionsService"},", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">"],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreSetup","text":"CoreSetup"},""],"description":[],"source":{"path":"src/plugins/expressions/server/plugin.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L22"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/server/plugin.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L22"}},{"id":"def-server.ExpressionsServerPlugin.start","type":"Function","label":"start","signature":["(core: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreStart","text":"CoreStart"},") => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionsServiceStart","text":"ExpressionsServiceStart"}],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.CoreStart","text":"CoreStart"}],"description":[],"source":{"path":"src/plugins/expressions/server/plugin.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L32"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/server/plugin.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L32"}},{"id":"def-server.ExpressionsServerPlugin.stop","type":"Function","label":"stop","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/server/plugin.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L38"}}],"source":{"path":"src/plugins/expressions/server/plugin.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L16"},"initialIsOpen":false}],"functions":[{"id":"def-server.buildExpression","type":"Function","label":"buildExpression","signature":["(initialState: string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}," | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstFunctionBuilder","text":"ExpressionAstFunctionBuilder"},"<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"},">[] | undefined) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpressionBuilder","text":"ExpressionAstExpressionBuilder"}],"description":["\nMakes it easy to progressively build, update, and traverse an\nexpression AST. You can either start with an empty AST, or\nprovide an expression string, AST, or array of expression\nfunction builders to use as initial state.\n"],"children":[{"type":"CompoundType","label":"initialState","isRequired":false,"signature":["string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}," | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstFunctionBuilder","text":"ExpressionAstFunctionBuilder"},"<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"},">[] | undefined"],"description":["Optional. An expression string, AST, or array of `ExpressionAstFunctionBuilder[]`."],"source":{"path":"src/plugins/expressions/common/ast/build_expression.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L98"}}],"tags":["return"],"returnComment":["`this`"],"source":{"path":"src/plugins/expressions/common/ast/build_expression.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L97"},"initialIsOpen":false},{"id":"def-server.buildExpressionFunction","type":"Function","label":"buildExpressionFunction","signature":["(fnName: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.InferFunctionDefinition","text":"InferFunctionDefinition"},"[\"name\"], initialArgs: { [K in keyof FunctionArgs]: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpressionBuilder","text":"ExpressionAstExpressionBuilder"}," | FunctionArgs[K] | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpressionBuilder","text":"ExpressionAstExpressionBuilder"},"[]; }) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstFunctionBuilder","text":"ExpressionAstFunctionBuilder"},""],"description":["\nManages an AST for a single expression function. The return value\ncan be provided to `buildExpression` to add this function to an\nexpression.\n\nNote that to preserve type safety and ensure no args are missing,\nall required arguments for the specified function must be provided\nup front. If desired, they can be changed or removed later.\n"],"children":[{"type":"Uncategorized","label":"fnName","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.InferFunctionDefinition","text":"InferFunctionDefinition"},"[\"name\"]"],"description":["String representing the name of this expression function."],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":155,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L155"}},{"type":"Object","label":"initialArgs","isRequired":true,"signature":["{ [K in keyof FunctionArgs]: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpressionBuilder","text":"ExpressionAstExpressionBuilder"}," | FunctionArgs[K] | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpressionBuilder","text":"ExpressionAstExpressionBuilder"},"[]; }"],"description":["Object containing the arguments to this function."],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":163,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L163"}}],"tags":["return"],"returnComment":["`this`"],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":152,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L152"},"initialIsOpen":false},{"id":"def-server.format","type":"Function","label":"format","signature":["(ast: T, type: T extends ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}," ? \"expression\" : \"argument\") => string"],"description":[],"children":[{"type":"Uncategorized","label":"ast","isRequired":true,"signature":["T"],"description":[],"source":{"path":"src/plugins/expressions/common/ast/format.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/format.ts#L15"}},{"type":"Uncategorized","label":"type","isRequired":true,"signature":["T extends ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}," ? \"expression\" : \"argument\""],"description":[],"source":{"path":"src/plugins/expressions/common/ast/format.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/format.ts#L16"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/ast/format.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/format.ts#L14"},"initialIsOpen":false},{"id":"def-server.formatExpression","type":"Function","label":"formatExpression","signature":["(ast: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},") => string"],"description":["\nGiven expression pipeline AST, returns formatted string.\n"],"children":[{"type":"Object","label":"ast","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":["Expression pipeline AST."],"source":{"path":"src/plugins/expressions/common/ast/format_expression.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/format_expression.ts#L17"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/ast/format_expression.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/format_expression.ts#L17"},"initialIsOpen":false},{"id":"def-server.isExpressionAstBuilder","type":"Function","label":"isExpressionAstBuilder","signature":["(val: any) => boolean"],"description":["\nType guard that checks whether a given value is an\n`ExpressionAstExpressionBuilder`. This is useful when working\nwith subexpressions, where you might be retrieving a function\nargument, and need to know whether it is an expression builder\ninstance which you can perform operations on.\n"],"children":[{"type":"Any","label":"val","isRequired":true,"signature":["any"],"description":["Value you want to check."],"source":{"path":"src/plugins/expressions/common/ast/build_expression.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L35"}}],"tags":["example","return"],"returnComment":["boolean"],"source":{"path":"src/plugins/expressions/common/ast/build_expression.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L35"},"initialIsOpen":false},{"id":"def-server.parse","type":"Function","label":"parse","signature":["(expression: E, startRule: S) => S extends \"expression\" ? ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}," : ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstArgument","text":"ExpressionAstArgument"}],"description":[],"children":[{"type":"Uncategorized","label":"expression","isRequired":true,"signature":["E"],"description":[],"source":{"path":"src/plugins/expressions/common/ast/parse.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/parse.ts#L15"}},{"type":"Uncategorized","label":"startRule","isRequired":true,"signature":["S"],"description":[],"source":{"path":"src/plugins/expressions/common/ast/parse.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/parse.ts#L16"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/ast/parse.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/parse.ts#L14"},"initialIsOpen":false},{"id":"def-server.parseExpression","type":"Function","label":"parseExpression","signature":["(expression: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":["\nGiven expression pipeline string, returns parsed AST.\n"],"children":[{"type":"string","label":"expression","isRequired":true,"signature":["string"],"description":["Expression pipeline string."],"source":{"path":"src/plugins/expressions/common/ast/parse_expression.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/parse_expression.ts#L17"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/ast/parse_expression.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/parse_expression.ts#L17"},"initialIsOpen":false}],"interfaces":[{"id":"def-server.Datatable","type":"Interface","label":"Datatable","description":["\nA `Datatable` in Canvas is a unique structure that represents tabulated data."],"children":[{"id":"def-server.Datatable.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L99"},"signature":["\"datatable\""]},{"id":"def-server.Datatable.columns","type":"Array","label":"columns","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":100,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L100"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.DatatableColumn","text":"DatatableColumn"},"[]"]},{"id":"def-server.Datatable.rows","type":"Array","label":"rows","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L101"},"signature":["Record[]"]}],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L98"},"initialIsOpen":false},{"id":"def-server.DatatableColumn","type":"Interface","label":"DatatableColumn","description":["\nThis type represents the shape of a column in a `Datatable`."],"children":[{"id":"def-server.DatatableColumn.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L90"}},{"id":"def-server.DatatableColumn.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":91,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L91"}},{"id":"def-server.DatatableColumn.meta","type":"Object","label":"meta","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L92"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.DatatableColumnMeta","text":"DatatableColumnMeta"}]}],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L89"},"initialIsOpen":false},{"id":"def-server.ExecutionContext","type":"Interface","label":"ExecutionContext","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},""],"description":["\n`ExecutionContext` is an object available to all functions during a single execution;\nit provides various methods to perform side-effects."],"children":[{"id":"def-server.ExecutionContext.getSearchContext","type":"Function","label":"getSearchContext","description":["\nGet search context of the expression."],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L28"},"signature":["() => ExecutionContextSearch"]},{"id":"def-server.ExecutionContext.variables","type":"Object","label":"variables","description":["\nContext variables that can be consumed using `var` and `var_set` functions."],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L33"},"signature":["Record"]},{"id":"def-server.ExecutionContext.types","type":"Object","label":"types","description":["\nA map of available expression types."],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L38"},"signature":["Record"]},{"id":"def-server.ExecutionContext.abortSignal","type":"Object","label":"abortSignal","description":["\nAdds ability to abort current execution."],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L43"},"signature":["AbortSignal"]},{"id":"def-server.ExecutionContext.inspectorAdapters","type":"Uncategorized","label":"inspectorAdapters","description":["\nAdapters for `inspector` plugin."],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L48"},"signature":["InspectorAdapters"]},{"id":"def-server.ExecutionContext.getSearchSessionId","type":"Function","label":"getSearchSessionId","description":["\nSearch context in which expression should operate."],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L53"},"signature":["() => string | undefined"]},{"id":"def-server.ExecutionContext.getKibanaRequest","type":"Function","label":"getKibanaRequest","description":["\nGetter to retrieve the `KibanaRequest` object inside an expression function.\nUseful for functions which are running on the server and need to perform\noperations that are scoped to a specific user."],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L60"},"signature":["(() => ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},") | undefined"]},{"id":"def-server.ExecutionContext.getSavedObject","type":"Function","label":"getSavedObject","description":["\nAllows to fetch saved objects from ElasticSearch. In browser `getSavedObject`\nfunction is provided automatically by the Expressions plugin. On the server\nthe caller of the expression has to provide this context function. The\nreason is because on the browser we always know the user who tries to\nfetch a saved object, thus saved object client is scoped automatically to\nthat user. However, on the server we can scope that saved object client to\nany user, or even not scope it at all and execute it as an \"internal\" user."],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L71"},"signature":["((type: string, id: string) => Promise<",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},">) | undefined"]},{"id":"def-server.ExecutionContext.isSyncColorsEnabled","type":"Function","label":"isSyncColorsEnabled","description":["\nReturns the state (true|false) of the sync colors across panels switch."],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L79"},"signature":["(() => boolean) | undefined"]}],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L21"},"initialIsOpen":false},{"id":"def-server.ExecutionParams","type":"Interface","label":"ExecutionParams","description":[],"children":[{"id":"def-server.ExecutionParams.executor","type":"Object","label":"executor","description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L58"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Executor","text":"Executor"},""]},{"id":"def-server.ExecutionParams.ast","type":"Object","label":"ast","description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L59"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}," | undefined"]},{"id":"def-server.ExecutionParams.expression","type":"string","label":"expression","description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L60"},"signature":["string | undefined"]},{"id":"def-server.ExecutionParams.params","type":"Object","label":"params","description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L61"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionExecutionParams","text":"ExpressionExecutionParams"}]}],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L57"},"initialIsOpen":false},{"id":"def-server.ExecutionState","type":"Interface","label":"ExecutionState","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionState","text":"ExecutionState"}," extends ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"},">"],"description":[],"children":[{"id":"def-server.ExecutionState.ast","type":"Object","label":"ast","description":[],"source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L18"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}]},{"id":"def-server.ExecutionState.state","type":"CompoundType","label":"state","description":["\nTracks state of execution.\n\n- `not-started` - before .start() method was called.\n- `pending` - immediately after .start() method is called.\n- `result` - when expression execution completed.\n- `error` - when execution failed with error."],"source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L28"},"signature":["\"result\" | \"error\" | \"not-started\" | \"pending\""]},{"id":"def-server.ExecutionState.result","type":"Uncategorized","label":"result","description":["\nResult of the expression execution."],"source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L33"},"signature":["Output | undefined"]},{"id":"def-server.ExecutionState.error","type":"Object","label":"error","description":["\nError happened during the execution."],"source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L38"},"signature":["Error | undefined"]}],"source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L17"},"initialIsOpen":false},{"id":"def-server.ExecutorState","type":"Interface","label":"ExecutorState","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"},""],"description":[],"children":[{"id":"def-server.ExecutorState.functions","type":"Object","label":"functions","description":[],"source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L17"},"signature":["Record"]},{"id":"def-server.ExecutorState.types","type":"Object","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L18"},"signature":["Record"]},{"id":"def-server.ExecutorState.context","type":"Uncategorized","label":"context","description":[],"source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L19"},"signature":["Context"]}],"source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L16"},"initialIsOpen":false},{"id":"def-server.ExpressionAstExpressionBuilder","type":"Interface","label":"ExpressionAstExpressionBuilder","description":[],"children":[{"id":"def-server.ExpressionAstExpressionBuilder.type","type":"string","label":"type","description":["\nUsed to identify expression builder objects."],"source":{"path":"src/plugins/expressions/common/ast/build_expression.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L48"},"signature":["\"expression_builder\""]},{"id":"def-server.ExpressionAstExpressionBuilder.functions","type":"Array","label":"functions","description":["\nArray of each of the `buildExpressionFunction()` instances\nin this expression. Use this to remove or reorder functions\nin the expression."],"source":{"path":"src/plugins/expressions/common/ast/build_expression.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L54"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstFunctionBuilder","text":"ExpressionAstFunctionBuilder"},"<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"},">[]"]},{"id":"def-server.ExpressionAstExpressionBuilder.findFunction","type":"Function","label":"findFunction","description":["\nRecursively searches expression for all ocurrences of the\nfunction, including in subexpressions.\n\nUseful when performing migrations on a specific function,\nas you can iterate over the array of references and update\nall functions at once.\n"],"source":{"path":"src/plugins/expressions/common/ast/build_expression.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L66"},"signature":["(fnName: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.InferFunctionDefinition","text":"InferFunctionDefinition"},"[\"name\"]) => [] | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstFunctionBuilder","text":"ExpressionAstFunctionBuilder"},"[]"]},{"id":"def-server.ExpressionAstExpressionBuilder.toAst","type":"Function","label":"toAst","description":["\nConverts expression to an AST.\n"],"source":{"path":"src/plugins/expressions/common/ast/build_expression.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L74"},"signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}]},{"id":"def-server.ExpressionAstExpressionBuilder.toString","type":"Function","label":"toString","description":["\nConverts expression to an expression string.\n"],"source":{"path":"src/plugins/expressions/common/ast/build_expression.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L80"},"signature":["() => string"]}],"source":{"path":"src/plugins/expressions/common/ast/build_expression.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L44"},"initialIsOpen":false},{"id":"def-server.ExpressionAstFunctionBuilder","type":"Interface","label":"ExpressionAstFunctionBuilder","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstFunctionBuilder","text":"ExpressionAstFunctionBuilder"},""],"description":[],"children":[{"id":"def-server.ExpressionAstFunctionBuilder.type","type":"string","label":"type","description":["\nUsed to identify expression function builder objects."],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L63"},"signature":["\"expression_function_builder\""]},{"id":"def-server.ExpressionAstFunctionBuilder.name","type":"Uncategorized","label":"name","description":["\nName of this expression function."],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L67"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.InferFunctionDefinition","text":"InferFunctionDefinition"},"[\"name\"]"]},{"id":"def-server.ExpressionAstFunctionBuilder.arguments","type":"Object","label":"arguments","description":["\nObject of all args currently added to the function. This is\nstructured similarly to `ExpressionAstFunction['arguments']`,\nhowever any subexpressions are returned as expression builder\ninstances instead of expression ASTs."],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L74"},"signature":["FunctionBuilderArguments"]},{"id":"def-server.ExpressionAstFunctionBuilder.addArgument","type":"Function","label":"addArgument","description":["\nAdds an additional argument to the function. For multi-args,\nthis should be called once for each new arg. Note that TS\nwill not enforce whether multi-args are available, so only\nuse this to update an existing arg if you are certain it\nis a multi-arg.\n"],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L86"},"signature":[">(name: A, value: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpressionBuilder","text":"ExpressionAstExpressionBuilder"}," | FunctionArgs[A]) => this"]},{"id":"def-server.ExpressionAstFunctionBuilder.getArgument","type":"Function","label":"getArgument","description":["\nRetrieves an existing argument by name.\nUseful when you want to retrieve the current array of args and add\nsomething to it before calling `replaceArgument`. Any subexpression\narguments will be returned as expression builder instances.\n"],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L99"},"signature":[">(name: A) => (",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpressionBuilder","text":"ExpressionAstExpressionBuilder"}," | FunctionArgs[A])[] | undefined"]},{"id":"def-server.ExpressionAstFunctionBuilder.replaceArgument","type":"Function","label":"replaceArgument","description":["\nOverwrites an existing argument with a new value.\nIn order to support multi-args, the value given must always be\nan array.\n"],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":111,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L111"},"signature":[">(name: A, value: (",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpressionBuilder","text":"ExpressionAstExpressionBuilder"}," | FunctionArgs[A])[]) => this"]},{"id":"def-server.ExpressionAstFunctionBuilder.removeArgument","type":"Function","label":"removeArgument","description":["\nRemoves an (optional) argument from the function.\n\nTypeScript will enforce that you only remove optional\narguments. For manipulating required args, use `replaceArgument`.\n"],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":124,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L124"},"signature":[">>(name: A) => this"]},{"id":"def-server.ExpressionAstFunctionBuilder.toAst","type":"Function","label":"toAst","description":["\nConverts function to an AST.\n"],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":130,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L130"},"signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstFunction","text":"ExpressionAstFunction"}]},{"id":"def-server.ExpressionAstFunctionBuilder.toString","type":"Function","label":"toString","description":["\nConverts function to an expression string.\n"],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":136,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L136"},"signature":["() => string"]}],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L57"},"initialIsOpen":false},{"id":"def-server.ExpressionFunctionDefinition","type":"Interface","label":"ExpressionFunctionDefinition","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunctionDefinition","text":"ExpressionFunctionDefinition"}," extends Partial<",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.PersistableState","text":"PersistableState"},">>"],"description":["\n`ExpressionFunctionDefinition` is the interface plugins have to implement to\nregister a function in `expressions` plugin."],"children":[{"id":"def-server.ExpressionFunctionDefinition.name","type":"Uncategorized","label":"name","description":["\nThe name of the function, as will be used in expression."],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L40"},"signature":["Name"]},{"id":"def-server.ExpressionFunctionDefinition.disabled","type":"CompoundType","label":"disabled","description":["\nif set to true function will be disabled (but its migrate function will still be available)"],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L45"},"signature":["boolean | undefined"]},{"id":"def-server.ExpressionFunctionDefinition.type","type":"CompoundType","label":"type","description":["\nName of type of value this function outputs."],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L50"},"signature":["\"date\" | \"filter\" | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.KnownTypeToString","text":"KnownTypeToString"},"<","UnwrapPromiseOrReturn","> | undefined"]},{"id":"def-server.ExpressionFunctionDefinition.inputTypes","type":"Array","label":"inputTypes","description":["\nList of allowed type names for input value of this function. If this\nproperty is set the input of function will be cast to the first possible\ntype in this list. If this property is missing the input will be provided\nto the function as-is."],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L58"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.TypeToString","text":"TypeToString"},"[] | undefined"]},{"id":"def-server.ExpressionFunctionDefinition.args","type":"Object","label":"args","description":["\nSpecification of arguments that function supports. This list will also be\nused for autocomplete functionality when your function is being edited."],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L64"},"signature":["{ [key in keyof Arguments]: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ArgumentType","text":"ArgumentType"},"; }"]},{"id":"def-server.ExpressionFunctionDefinition.aliases","type":"Array","label":"aliases","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L69"},"signature":["string[] | undefined"]},{"id":"def-server.ExpressionFunctionDefinition.help","type":"string","label":"help","description":["\nHelp text displayed in the Expression editor. This text should be\ninternationalized."],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L75"}},{"id":"def-server.ExpressionFunctionDefinition.fn","type":"Function","label":"fn","signature":["(input: Input, args: Arguments, context: Context) => Output"],"description":["\nThe actual implementation of the function.\n"],"children":[{"type":"Uncategorized","label":"input","isRequired":true,"signature":["Input"],"description":["Output of the previous function, or initial input."],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L86"}},{"type":"Uncategorized","label":"args","isRequired":true,"signature":["Arguments"],"description":["Parameters set for this function in expression."],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L86"}},{"type":"Uncategorized","label":"context","isRequired":true,"signature":["Context"],"description":["Object with functions to perform side effects. This object\nis created for the duration of the execution of expression and is the\nsame for all functions in expression chain."],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L86"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L86"}},{"id":"def-server.ExpressionFunctionDefinition.context","type":"Object","label":"context","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":91,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L91"},"signature":["{ types: any[] | undefined; } | undefined"]}],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L30"},"initialIsOpen":false},{"id":"def-server.ExpressionFunctionDefinitions","type":"Interface","label":"ExpressionFunctionDefinitions","description":["\nA mapping of `ExpressionFunctionDefinition`s for functions which the\nExpressions services provides out-of-the-box. Any new functions registered\nby the Expressions plugin should have their types added here.\n"],"children":[{"id":"def-server.ExpressionFunctionDefinitions.clog","type":"Object","label":"clog","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":117,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L117"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunctionClog","text":"ExpressionFunctionClog"}]},{"id":"def-server.ExpressionFunctionDefinitions.font","type":"Object","label":"font","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":118,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L118"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunctionFont","text":"ExpressionFunctionFont"}]},{"id":"def-server.ExpressionFunctionDefinitions.var_set","type":"Object","label":"var_set","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":119,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L119"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunctionVarSet","text":"ExpressionFunctionVarSet"}]},{"id":"def-server.ExpressionFunctionDefinitions.var","type":"Object","label":"var","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":120,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L120"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunctionVar","text":"ExpressionFunctionVar"}]},{"id":"def-server.ExpressionFunctionDefinitions.theme","type":"Object","label":"theme","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":121,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L121"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunctionTheme","text":"ExpressionFunctionTheme"}]},{"id":"def-server.ExpressionFunctionDefinitions.cumulative_sum","type":"Object","label":"cumulative_sum","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":122,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L122"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunctionCumulativeSum","text":"ExpressionFunctionCumulativeSum"}]},{"id":"def-server.ExpressionFunctionDefinitions.derivative","type":"Object","label":"derivative","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":123,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L123"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunctionDerivative","text":"ExpressionFunctionDerivative"}]},{"id":"def-server.ExpressionFunctionDefinitions.moving_average","type":"Object","label":"moving_average","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":124,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L124"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunctionMovingAverage","text":"ExpressionFunctionMovingAverage"}]}],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L116"},"initialIsOpen":false},{"id":"def-server.ExpressionImage","type":"Interface","label":"ExpressionImage","description":[],"children":[{"id":"def-server.ExpressionImage.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/image.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L15"},"signature":["\"image\""]},{"id":"def-server.ExpressionImage.mode","type":"string","label":"mode","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/image.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L16"}},{"id":"def-server.ExpressionImage.dataurl","type":"string","label":"dataurl","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/image.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L17"}}],"source":{"path":"src/plugins/expressions/common/expression_types/specs/image.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L14"},"initialIsOpen":false},{"id":"def-server.ExpressionRenderDefinition","type":"Interface","label":"ExpressionRenderDefinition","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRenderDefinition","text":"ExpressionRenderDefinition"},""],"description":[],"children":[{"id":"def-server.ExpressionRenderDefinition.name","type":"string","label":"name","description":["\nTechnical name of the renderer, used as ID to identify renderer in\nexpression renderer registry. This must match the name of the expression\nfunction that is used to create the `type: render` object."],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L15"}},{"id":"def-server.ExpressionRenderDefinition.displayName","type":"string","label":"displayName","description":["\nA user friendly name of the renderer as will be displayed to user in UI."],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L20"},"signature":["string | undefined"]},{"id":"def-server.ExpressionRenderDefinition.help","type":"string","label":"help","description":["\nHelp text as will be displayed to user. A sentence or few about what this\nelement does."],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L26"},"signature":["string | undefined"]},{"id":"def-server.ExpressionRenderDefinition.validate","type":"Function","label":"validate","description":["\nUsed to validate the data before calling the render function."],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L31"},"signature":["(() => Error | undefined) | undefined"]},{"id":"def-server.ExpressionRenderDefinition.reuseDomNode","type":"boolean","label":"reuseDomNode","description":["\nTell the renderer if the dom node should be reused, it's recreated each\ntime by default."],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L37"}},{"id":"def-server.ExpressionRenderDefinition.render","type":"Function","label":"render","description":["\nThe function called to render the output data of an expression."],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L42"},"signature":["(domNode: HTMLElement, config: Config, handlers: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.IInterpreterRenderHandlers","text":"IInterpreterRenderHandlers"},") => void | Promise"]}],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L9"},"initialIsOpen":false},{"id":"def-server.ExpressionTypeDefinition","type":"Interface","label":"ExpressionTypeDefinition","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionTypeDefinition","text":"ExpressionTypeDefinition"},""],"description":["\nA generic type which represents a custom Expression Type Definition that's\nregistered to the Interpreter."],"children":[{"id":"def-server.ExpressionTypeDefinition.name","type":"Uncategorized","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L31"},"signature":["Name"]},{"id":"def-server.ExpressionTypeDefinition.validate","type":"Function","label":"validate","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L32"},"signature":["((type: any) => void | Error) | undefined"]},{"id":"def-server.ExpressionTypeDefinition.serialize","type":"Function","label":"serialize","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L33"},"signature":["((type: Value) => SerializedType) | undefined"]},{"id":"def-server.ExpressionTypeDefinition.deserialize","type":"Function","label":"deserialize","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L34"},"signature":["((type: SerializedType) => Value) | undefined"]},{"id":"def-server.ExpressionTypeDefinition.from","type":"Object","label":"from","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L37"},"signature":["{ [type: string]: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueConverter","text":"ExpressionValueConverter"},"; } | undefined"]},{"id":"def-server.ExpressionTypeDefinition.to","type":"Object","label":"to","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L40"},"signature":["{ [type: string]: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueConverter","text":"ExpressionValueConverter"},"; } | undefined"]},{"id":"def-server.ExpressionTypeDefinition.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L43"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L26"},"initialIsOpen":false},{"id":"def-server.ExpressionTypeStyle","type":"Interface","label":"ExpressionTypeStyle","description":["\nAn object that represents style information, typically CSS."],"children":[{"id":"def-server.ExpressionTypeStyle.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":121,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L121"},"signature":["\"style\""]},{"id":"def-server.ExpressionTypeStyle.spec","type":"Object","label":"spec","description":[],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":122,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L122"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.CSSStyle","text":"CSSStyle"}]},{"id":"def-server.ExpressionTypeStyle.css","type":"string","label":"css","description":[],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":123,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L123"}}],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":120,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L120"},"initialIsOpen":false},{"id":"def-server.Font","type":"Interface","label":"Font","description":["\nAn interface representing a font in Canvas, with a textual label and the CSS\n`font-value`."],"children":[{"id":"def-server.Font.label","type":"CompoundType","label":"label","description":[],"source":{"path":"src/plugins/expressions/common/fonts.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L26"},"signature":["\"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Lucida Grande\" | \"Myriad\" | \"Open Sans\" | \"Optima\" | \"Palatino\""]},{"id":"def-server.Font.value","type":"CompoundType","label":"value","description":[],"source":{"path":"src/plugins/expressions/common/fonts.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L27"},"signature":["\"'American Typewriter', 'Courier New', Courier, Monaco, mono\" | \"Arial, sans-serif\" | \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Brush Script MT', 'Comic Sans', sans-serif\" | \"Chalkboard, 'Comic Sans', sans-serif\" | \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"Futura, Impact, Helvetica, Arial, sans-serif\" | \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"'Helvetica Neue', Helvetica, Arial, sans-serif\" | \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\" | \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\" | \"Myriad, Helvetica, Arial, sans-serif\" | \"'Open Sans', Helvetica, Arial, sans-serif\" | \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\""]}],"source":{"path":"src/plugins/expressions/common/fonts.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L25"},"initialIsOpen":false},{"id":"def-server.IInterpreterRenderHandlers","type":"Interface","label":"IInterpreterRenderHandlers","description":[],"children":[{"id":"def-server.IInterpreterRenderHandlers.done","type":"Function","label":"done","description":["\nDone increments the number of rendering successes"],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L67"},"signature":["() => void"]},{"id":"def-server.IInterpreterRenderHandlers.onDestroy","type":"Function","label":"onDestroy","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L68"},"signature":["(fn: () => void) => void"]},{"id":"def-server.IInterpreterRenderHandlers.reload","type":"Function","label":"reload","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L69"},"signature":["() => void"]},{"id":"def-server.IInterpreterRenderHandlers.update","type":"Function","label":"update","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L70"},"signature":["(params: any) => void"]},{"id":"def-server.IInterpreterRenderHandlers.event","type":"Function","label":"event","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L71"},"signature":["(event: any) => void"]},{"id":"def-server.IInterpreterRenderHandlers.hasCompatibleActions","type":"Function","label":"hasCompatibleActions","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L72"},"signature":["((event: any) => Promise) | undefined"]},{"id":"def-server.IInterpreterRenderHandlers.getRenderMode","type":"Function","label":"getRenderMode","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L73"},"signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.RenderMode","text":"RenderMode"}]},{"id":"def-server.IInterpreterRenderHandlers.isSyncColorsEnabled","type":"Function","label":"isSyncColorsEnabled","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L74"},"signature":["() => boolean"]},{"id":"def-server.IInterpreterRenderHandlers.uiState","type":"Unknown","label":"uiState","description":["\nThis uiState interface is actually `PersistedState` from the visualizations plugin,\nbut expressions cannot know about vis or it creates a mess of circular dependencies.\nDownstream consumers of the uiState handler will need to cast for now."],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L80"},"signature":["unknown"]}],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L63"},"initialIsOpen":false},{"id":"def-server.IRegistry","type":"Interface","label":"IRegistry","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.IRegistry","text":"IRegistry"},""],"description":[],"children":[{"id":"def-server.IRegistry.get","type":"Function","label":"get","signature":["(id: string) => T | null"],"description":[],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/types/registry.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/registry.ts#L10"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/types/registry.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/registry.ts#L10"}},{"id":"def-server.IRegistry.toJS","type":"Function","label":"toJS","signature":["() => Record"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/types/registry.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/registry.ts#L12"}},{"id":"def-server.IRegistry.toArray","type":"Function","label":"toArray","signature":["() => T[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/types/registry.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/registry.ts#L14"}}],"source":{"path":"src/plugins/expressions/common/types/registry.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/registry.ts#L9"},"initialIsOpen":false},{"id":"def-server.PointSeriesColumn","type":"Interface","label":"PointSeriesColumn","description":["\nColumn in a PointSeries"],"children":[{"id":"def-server.PointSeriesColumn.type","type":"CompoundType","label":"type","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L24"},"signature":["\"string\" | \"number\""]},{"id":"def-server.PointSeriesColumn.role","type":"CompoundType","label":"role","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L25"},"signature":["\"measure\" | \"dimension\""]},{"id":"def-server.PointSeriesColumn.expression","type":"string","label":"expression","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L26"}}],"source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L23"},"initialIsOpen":false},{"id":"def-server.Range","type":"Interface","label":"Range","description":[],"children":[{"id":"def-server.Range.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/range.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L15"},"signature":["\"range\""]},{"id":"def-server.Range.from","type":"number","label":"from","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/range.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L16"}},{"id":"def-server.Range.to","type":"number","label":"to","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/range.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L17"}},{"id":"def-server.Range.label","type":"string","label":"label","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/range.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L18"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/expressions/common/expression_types/specs/range.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L14"},"initialIsOpen":false},{"id":"def-server.SerializedDatatable","type":"Interface","label":"SerializedDatatable","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializedDatatable","text":"SerializedDatatable"}," extends ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"}],"description":[],"children":[{"id":"def-server.SerializedDatatable.rows","type":"Array","label":"rows","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":105,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L105"},"signature":["string[][]"]}],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L104"},"initialIsOpen":false},{"id":"def-server.SerializedFieldFormat","type":"Interface","label":"SerializedFieldFormat","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializedFieldFormat","text":"SerializedFieldFormat"},""],"description":["\nJSON representation of a field formatter configuration.\nIs used to carry information about how to format data in\na data table as part of the column definition."],"children":[{"id":"def-server.SerializedFieldFormat.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/expressions/common/types/common.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L54"},"signature":["string | undefined"]},{"id":"def-server.SerializedFieldFormat.params","type":"Uncategorized","label":"params","description":[],"source":{"path":"src/plugins/expressions/common/types/common.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L55"},"signature":["TParams | undefined"]}],"source":{"path":"src/plugins/expressions/common/types/common.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L53"},"initialIsOpen":false}],"enums":[{"id":"def-server.FontStyle","type":"Enum","label":"FontStyle","description":["\nEnum of supported CSS `font-style` properties."],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L35"},"initialIsOpen":false},{"id":"def-server.FontWeight","type":"Enum","label":"FontWeight","description":["\nEnum of supported CSS `font-weight` properties."],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L43"},"initialIsOpen":false},{"id":"def-server.Overflow","type":"Enum","label":"Overflow","description":["\nEnum of supported CSS `overflow` properties."],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L62"},"initialIsOpen":false},{"id":"def-server.TextAlignment","type":"Enum","label":"TextAlignment","description":["\nEnum of supported CSS `text-align` properties."],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L72"},"initialIsOpen":false},{"id":"def-server.TextDecoration","type":"Enum","label":"TextDecoration","description":["\nEnum of supported CSS `text-decoration` properties."],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L82"},"initialIsOpen":false}],"misc":[{"id":"def-server.AnyExpressionFunctionDefinition","type":"Type","label":"AnyExpressionFunctionDefinition","description":["\nType to capture every possible expression function definition."],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L102"},"signature":["ExpressionFunctionDefinition, any, ExecutionContext<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},">>"],"initialIsOpen":false},{"id":"def-server.AnyExpressionTypeDefinition","type":"Type","label":"AnyExpressionTypeDefinition","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L46"},"signature":["ExpressionTypeDefinition"],"initialIsOpen":false},{"id":"def-server.ArgumentType","type":"Type","label":"ArgumentType","description":["\nThis type represents all of the possible combinations of properties of an\nArgument in an Expression Function. The presence or absence of certain fields\ninfluence the shape and presence of others within each `arg` in the specification."],"source":{"path":"src/plugins/expressions/common/expression_functions/arguments.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/arguments.ts#L16"},"signature":["SingleArgumentType | MultipleArgumentType | UnresolvedSingleArgumentType | UnresolvedMultipleArgumentType"],"initialIsOpen":false},{"id":"def-server.DatatableColumnType","type":"Type","label":"DatatableColumnType","description":["\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES"],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L36"},"signature":["\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\""],"initialIsOpen":false},{"id":"def-server.DatatableRow","type":"Type","label":"DatatableRow","description":["\nThis type represents a row in a `Datatable`."],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L57"},"signature":["{ [x: string]: any; }"],"initialIsOpen":false},{"id":"def-server.ExecutionContainer","type":"Type","label":"ExecutionContainer","description":[],"source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L73"},"signature":["StateContainer, ExecutionPureTransitions, {}>"],"initialIsOpen":false},{"id":"def-server.ExecutorContainer","type":"Type","label":"ExecutorContainer","description":[],"source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L55"},"signature":["StateContainer, ExecutorPureTransitions, ExecutorPureSelectors>"],"initialIsOpen":false},{"id":"def-server.ExpressionAstArgument","type":"Type","label":"ExpressionAstArgument","description":[],"source":{"path":"src/plugins/expressions/common/ast/types.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/types.ts#L77"},"signature":["string | number | false | true | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"initialIsOpen":false},{"id":"def-server.ExpressionAstExpression","type":"Type","label":"ExpressionAstExpression","description":[],"source":{"path":"src/plugins/expressions/common/ast/types.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/types.ts#L16"},"signature":["{ type: 'expression'; chain: ExpressionAstFunction[]; }"],"initialIsOpen":false},{"id":"def-server.ExpressionAstFunction","type":"Type","label":"ExpressionAstFunction","description":[],"source":{"path":"src/plugins/expressions/common/ast/types.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/types.ts#L21"},"signature":["{ type: 'function'; function: string; arguments: Record; debug?: ExpressionAstFunctionDebug | undefined; }"],"initialIsOpen":false},{"id":"def-server.ExpressionAstNode","type":"Type","label":"ExpressionAstNode","description":[],"source":{"path":"src/plugins/expressions/common/ast/types.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/types.ts#L11"},"signature":["string | number | false | true | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstFunction","text":"ExpressionAstFunction"}," | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"initialIsOpen":false},{"id":"def-server.ExpressionValue","type":"Type","label":"ExpressionValue","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L15"},"signature":["any"],"initialIsOpen":false},{"id":"def-server.ExpressionValueBoxed","type":"Type","label":"ExpressionValueBoxed","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L11"},"signature":["{ type: Type; } & Value"],"initialIsOpen":false},{"id":"def-server.ExpressionValueConverter","type":"Type","label":"ExpressionValueConverter","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L17"},"signature":["(input: I, availableTypes: Record) => O"],"initialIsOpen":false},{"id":"def-server.ExpressionValueError","type":"Type","label":"ExpressionValueError","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/error.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/error.ts#L17"},"signature":["{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }"],"initialIsOpen":false},{"id":"def-server.ExpressionValueNum","type":"Type","label":"ExpressionValueNum","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/num.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L14"},"signature":["{ type: \"num\"; } & { value: number; }"],"initialIsOpen":false},{"id":"def-server.ExpressionValueRender","type":"Type","label":"ExpressionValueRender","description":["\nRepresents an object that is intended to be rendered."],"source":{"path":"src/plugins/expressions/common/expression_types/specs/render.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/render.ts#L16"},"signature":["{ type: \"render\"; } & { as: string; value: T; }"],"initialIsOpen":false},{"id":"def-server.ExpressionValueUnboxed","type":"Type","label":"ExpressionValueUnboxed","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L9"},"signature":["any"],"initialIsOpen":false},{"id":"def-server.ExpressionValueFilter","type":"Type","label":"ExpressionValueFilter","description":["\nRepresents an object that is a Filter."],"source":{"path":"src/plugins/expressions/common/expression_types/specs/filter.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/filter.ts#L14"},"signature":["{ type: \"filter\"; } & { filterType?: string | undefined; value?: string | undefined; column?: string | undefined; and: ExpressionValueFilter[]; to?: string | undefined; from?: string | undefined; query?: string | null | undefined; }"],"initialIsOpen":false},{"id":"def-server.FontLabel","type":"Type","label":"FontLabel","description":["\nThis type contains a unions of all supported font labels, or the the name of\nthe font the user would see in a UI."],"source":{"path":"src/plugins/expressions/common/fonts.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L13"},"signature":["\"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Lucida Grande\" | \"Myriad\" | \"Open Sans\" | \"Optima\" | \"Palatino\""],"initialIsOpen":false},{"id":"def-server.FontValue","type":"Type","label":"FontValue","description":["\nThis type contains a union of all supported font values, equivalent to the CSS\n`font-value` property."],"source":{"path":"src/plugins/expressions/common/fonts.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L19"},"signature":["\"'American Typewriter', 'Courier New', Courier, Monaco, mono\" | \"Arial, sans-serif\" | \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Brush Script MT', 'Comic Sans', sans-serif\" | \"Chalkboard, 'Comic Sans', sans-serif\" | \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"Futura, Impact, Helvetica, Arial, sans-serif\" | \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"'Helvetica Neue', Helvetica, Arial, sans-serif\" | \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\" | \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\" | \"Myriad, Helvetica, Arial, sans-serif\" | \"'Open Sans', Helvetica, Arial, sans-serif\" | \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\""],"initialIsOpen":false},{"id":"def-server.InterpreterErrorType","type":"Type","label":"InterpreterErrorType","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/error.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/error.ts#L33"},"signature":["{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }"],"initialIsOpen":false},{"id":"def-server.KnownTypeToString","type":"Type","label":"KnownTypeToString","description":["\nMap the type of the generic to a string-based representation of the type.\n\nIf the provided generic is its own type interface, we use the value of\nthe `type` key as a string literal type for it."],"source":{"path":"src/plugins/expressions/common/types/common.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L26"},"signature":["T extends string ? \"string\" : T extends boolean ? \"boolean\" : T extends number ? \"number\" : T extends null ? \"null\" : T extends { type: string; } ? T[\"type\"] : never"],"initialIsOpen":false},{"id":"def-server.PointSeries","type":"Type","label":"PointSeries","description":["\nA `PointSeries` is a unique structure that represents dots on a chart."],"source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L39"},"signature":["{ type: \"pointseries\"; } & { columns: PointSeriesColumns; rows: PointSeriesRow[]; }"],"initialIsOpen":false},{"id":"def-server.PointSeriesColumnName","type":"Type","label":"PointSeriesColumnName","description":["\nAllowed column names in a PointSeries"],"source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L18"},"signature":["\"color\" | \"y\" | \"x\" | \"text\" | \"size\""],"initialIsOpen":false},{"id":"def-server.PointSeriesColumns","type":"Type","label":"PointSeriesColumns","description":["\nRepresents a collection of valid Columns in a PointSeries"],"source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L32"},"signature":["{} | Record<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.PointSeriesColumnName","text":"PointSeriesColumnName"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.PointSeriesColumn","text":"PointSeriesColumn"},">"],"initialIsOpen":false},{"id":"def-server.PointSeriesRow","type":"Type","label":"PointSeriesRow","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L34"},"signature":["{ [x: string]: any; }"],"initialIsOpen":false},{"id":"def-server.Style","type":"Type","label":"Style","description":[],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":126,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L126"},"signature":["ExpressionTypeStyle"],"initialIsOpen":false},{"id":"def-server.TypeString","type":"Type","label":"TypeString","description":["\nIf the type extends a Promise, we still need to return the string representation:\n\n`someArgument: Promise` results in `types: ['boolean', 'string']`"],"source":{"path":"src/plugins/expressions/common/types/common.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L39"},"signature":["UnwrapPromiseOrReturn extends string ? \"string\" : UnwrapPromiseOrReturn extends boolean ? \"boolean\" : UnwrapPromiseOrReturn extends number ? \"number\" : UnwrapPromiseOrReturn extends null ? \"null\" : UnwrapPromiseOrReturn extends { type: string; } ? ({ type: string; } & UnwrapPromiseOrReturn)[\"type\"] : never"],"initialIsOpen":false},{"id":"def-server.TypeToString","type":"Type","label":"TypeToString","description":["\nThis can convert a type into a known Expression string representation of\nthat type. For example, `TypeToString` will resolve to `'datatable'`.\nThis allows Expression Functions to continue to specify their type in a\nsimple string format."],"source":{"path":"src/plugins/expressions/common/types/common.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L17"},"signature":["\"date\" | \"filter\" | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.KnownTypeToString","text":"KnownTypeToString"},""],"initialIsOpen":false},{"id":"def-server.UnmappedTypeStrings","type":"Type","label":"UnmappedTypeStrings","description":["\nTypes used in Expressions that don't map to a primitive cleanly:\n\n`date` is typed as a number or string, and represents a date"],"source":{"path":"src/plugins/expressions/common/types/common.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L46"},"signature":["\"date\" | \"filter\""],"initialIsOpen":false},{"id":"def-server.ExpressionValueRender","type":"Type","label":"ExpressionValueRender","description":["\nRepresents an object that is intended to be rendered."],"source":{"path":"src/plugins/expressions/common/expression_types/specs/render.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/render.ts#L16"},"signature":["{ type: \"render\"; } & { as: string; value: T; }"],"initialIsOpen":false}],"objects":[],"setup":{"id":"def-server.ExpressionsServerSetup","type":"Type","label":"ExpressionsServerSetup","description":[],"source":{"path":"src/plugins/expressions/server/plugin.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/server/plugin.ts#L12"},"signature":["{ readonly getType: (name: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionType","text":"ExpressionType"}," | undefined; readonly getFunction: (name: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"}," | undefined; readonly getFunctions: () => Record; readonly getRenderer: (name: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRenderer","text":"ExpressionRenderer"}," | null; readonly getRenderers: () => Record void | Error"]},{"id":"def-common.ExpressionType.create","type":"Unknown","label":"create","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L25"},"signature":["unknown"]},{"id":"def-common.ExpressionType.serialize","type":"Function","label":"serialize","description":["\nOptional serialization (used when passing context around client/server)."],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L30"},"signature":["((value: any) => any) | undefined"]},{"id":"def-common.ExpressionType.deserialize","type":"Function","label":"deserialize","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L31"},"signature":["((serialized: any) => any) | undefined"]},{"id":"def-common.ExpressionType.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"definition","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"}],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L33"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L33"}},{"id":"def-common.ExpressionType.getToFn","type":"Function","children":[{"type":"string","label":"typeName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L48"}}],"signature":["(typeName: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueConverter","text":"ExpressionValueConverter"}," | undefined"],"description":[],"label":"getToFn","source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L47"},"returnComment":[]},{"id":"def-common.ExpressionType.getFromFn","type":"Function","children":[{"type":"string","label":"typeName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L53"}}],"signature":["(typeName: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueConverter","text":"ExpressionValueConverter"}," | undefined"],"description":[],"label":"getFromFn","source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L52"},"returnComment":[]},{"id":"def-common.ExpressionType.castsTo","type":"Function","children":[{"type":"Any","label":"value","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L57"}}],"signature":["(value: any) => boolean"],"description":[],"label":"castsTo","source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L57"},"returnComment":[]},{"id":"def-common.ExpressionType.castsFrom","type":"Function","children":[{"type":"Any","label":"value","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L59"}}],"signature":["(value: any) => boolean"],"description":[],"label":"castsFrom","source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L59"},"returnComment":[]},{"id":"def-common.ExpressionType.to","type":"Function","children":[{"type":"Any","label":"value","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L61"}},{"type":"string","label":"toTypeName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L61"}},{"type":"Object","label":"types","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L61"}}],"signature":["(value: any, toTypeName: string, types: Record) => any"],"description":[],"label":"to","source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L61"},"returnComment":[]},{"id":"def-common.ExpressionType.from","type":"Function","children":[{"type":"Any","label":"value","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L73"}},{"type":"Object","label":"types","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L73"}}],"signature":["(value: any, types: Record) => any"],"description":[],"label":"from","source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L73"},"returnComment":[]}],"source":{"path":"src/plugins/expressions/common/expression_types/expression_type.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/expression_type.ts#L12"},"initialIsOpen":false},{"id":"def-common.ExpressionFunctionParameter","type":"Class","label":"ExpressionFunctionParameter","description":[],"children":[{"id":"def-common.ExpressionFunctionParameter.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L12"}},{"id":"def-common.ExpressionFunctionParameter.required","type":"boolean","label":"required","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L13"}},{"id":"def-common.ExpressionFunctionParameter.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L14"}},{"id":"def-common.ExpressionFunctionParameter.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L15"},"signature":["string[]"]},{"id":"def-common.ExpressionFunctionParameter.default","type":"Any","label":"default","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L16"},"signature":["any"]},{"id":"def-common.ExpressionFunctionParameter.aliases","type":"Array","label":"aliases","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L17"},"signature":["string[]"]},{"id":"def-common.ExpressionFunctionParameter.multi","type":"boolean","label":"multi","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L18"}},{"id":"def-common.ExpressionFunctionParameter.resolve","type":"boolean","label":"resolve","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L19"}},{"id":"def-common.ExpressionFunctionParameter.options","type":"Array","label":"options","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L20"},"signature":["any[]"]},{"id":"def-common.ExpressionFunctionParameter.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L22"}},{"type":"CompoundType","label":"arg","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ArgumentType","text":"ArgumentType"},""],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L22"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L22"}},{"id":"def-common.ExpressionFunctionParameter.accepts","type":"Function","label":"accepts","signature":["(type: string) => boolean"],"description":[],"children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L40"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L40"}}],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function_parameter.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function_parameter.ts#L11"},"initialIsOpen":false},{"id":"def-common.ExpressionFunction","type":"Class","label":"ExpressionFunction","description":[],"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"}," implements ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.PersistableState","text":"PersistableState"},">"],"children":[{"id":"def-common.ExpressionFunction.name","type":"string","label":"name","description":["\nName of function"],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L22"}},{"id":"def-common.ExpressionFunction.aliases","type":"Array","label":"aliases","description":["\nAliases that can be used instead of `name`."],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L27"},"signature":["string[]"]},{"id":"def-common.ExpressionFunction.type","type":"string","label":"type","description":["\nReturn type of function. This SHOULD be supplied. We use it for UI\nand autocomplete hinting. We may also use it for optimizations in\nthe future."],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L34"}},{"id":"def-common.ExpressionFunction.fn","type":"Function","label":"fn","description":["\nFunction to run function (context, args)"],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L39"},"signature":["(input: any, params: Record, handlers: object) => any"]},{"id":"def-common.ExpressionFunction.help","type":"string","label":"help","description":["\nA short help text."],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L44"}},{"id":"def-common.ExpressionFunction.args","type":"Object","children":[],"description":["\nSpecification of expression function parameters."],"label":"args","source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L49"}},{"id":"def-common.ExpressionFunction.inputTypes","type":"Array","label":"inputTypes","description":["\nType of inputs that this function supports."],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L54"},"signature":["string[] | undefined"]},{"id":"def-common.ExpressionFunction.disabled","type":"boolean","label":"disabled","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L56"}},{"id":"def-common.ExpressionFunction.telemetry","type":"Function","label":"telemetry","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L57"},"signature":["(state: Record, telemetryData: Record) => Record"]},{"id":"def-common.ExpressionFunction.extract","type":"Function","label":"extract","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L61"},"signature":["(state: Record) => { state: Record; references: ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[]; }"]},{"id":"def-common.ExpressionFunction.inject","type":"Function","label":"inject","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L64"},"signature":["(state: Record, references: ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[]) => Record"]},{"id":"def-common.ExpressionFunction.migrations","type":"Object","label":"migrations","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L68"},"signature":["{ [key: string]: (state: ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},") => ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},"; }"]},{"id":"def-common.ExpressionFunction.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"functionDefinition","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"}],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L72"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L72"}},{"id":"def-common.ExpressionFunction.accepts","type":"Function","children":[{"type":"string","label":"type","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":107,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L107"}}],"signature":["(type: string) => boolean"],"description":[],"label":"accepts","source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":107,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L107"},"returnComment":[]}],"source":{"path":"src/plugins/expressions/common/expression_functions/expression_function.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/expression_function.ts#L18"},"initialIsOpen":false},{"id":"def-common.ExpressionRenderer","type":"Class","label":"ExpressionRenderer","description":[],"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRenderer","text":"ExpressionRenderer"},""],"children":[{"id":"def-common.ExpressionRenderer.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L12"}},{"id":"def-common.ExpressionRenderer.displayName","type":"string","label":"displayName","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L13"}},{"id":"def-common.ExpressionRenderer.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L14"}},{"id":"def-common.ExpressionRenderer.validate","type":"Function","label":"validate","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L15"},"signature":["() => void | Error"]},{"id":"def-common.ExpressionRenderer.reuseDomNode","type":"boolean","label":"reuseDomNode","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L16"}},{"id":"def-common.ExpressionRenderer.render","type":"Function","label":"render","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L17"},"signature":["(domNode: HTMLElement, config: Config, handlers: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.IInterpreterRenderHandlers","text":"IInterpreterRenderHandlers"},") => void | Promise"]},{"id":"def-common.ExpressionRenderer.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"config","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRenderDefinition","text":"ExpressionRenderDefinition"},""],"description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L19"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L19"}}],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer.ts#L11"},"initialIsOpen":false},{"id":"def-common.ExpressionRendererRegistry","type":"Class","label":"ExpressionRendererRegistry","description":[],"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRendererRegistry","text":"ExpressionRendererRegistry"}," implements ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.IRegistry","text":"IRegistry"},"<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRenderer","text":"ExpressionRenderer"},">"],"children":[{"id":"def-common.ExpressionRendererRegistry.register","type":"Function","label":"register","signature":["(definition: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionRenderDefinition","text":"AnyExpressionRenderDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionRenderDefinition","text":"AnyExpressionRenderDefinition"},")) => void"],"description":[],"children":[{"type":"CompoundType","label":"definition","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionRenderDefinition","text":"AnyExpressionRenderDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionRenderDefinition","text":"AnyExpressionRenderDefinition"},")"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L19"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L19"}},{"id":"def-common.ExpressionRendererRegistry.get","type":"Function","label":"get","signature":["(id: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRenderer","text":"ExpressionRenderer"}," | null"],"description":[],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L25"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L25"}},{"id":"def-common.ExpressionRendererRegistry.toJS","type":"Function","label":"toJS","signature":["() => Record>"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L29"}},{"id":"def-common.ExpressionRendererRegistry.toArray","type":"Function","label":"toArray","signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRenderer","text":"ExpressionRenderer"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L39"}}],"source":{"path":"src/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/expression_renderer_registry.ts#L13"},"initialIsOpen":false},{"id":"def-common.TypesRegistry","type":"Class","label":"TypesRegistry","description":[],"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.TypesRegistry","text":"TypesRegistry"}," implements ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.IRegistry","text":"IRegistry"},"<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionType","text":"ExpressionType"},">"],"children":[{"id":"def-common.TypesRegistry.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"executor","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Executor","text":"Executor"},""],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L37"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L37"}},{"id":"def-common.TypesRegistry.register","type":"Function","label":"register","signature":["(typeDefinition: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"},")) => void"],"description":[],"children":[{"type":"CompoundType","label":"typeDefinition","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"},")"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L40"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L39"}},{"id":"def-common.TypesRegistry.get","type":"Function","label":"get","signature":["(id: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionType","text":"ExpressionType"}," | null"],"description":[],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L45"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L45"}},{"id":"def-common.TypesRegistry.toJS","type":"Function","label":"toJS","signature":["() => Record"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L49"}},{"id":"def-common.TypesRegistry.toArray","type":"Function","label":"toArray","signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionType","text":"ExpressionType"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L53"}}],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L36"},"initialIsOpen":false},{"id":"def-common.FunctionsRegistry","type":"Class","label":"FunctionsRegistry","description":[],"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.FunctionsRegistry","text":"FunctionsRegistry"}," implements ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.IRegistry","text":"IRegistry"},"<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"},">"],"children":[{"id":"def-common.FunctionsRegistry.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"executor","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Executor","text":"Executor"},""],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L59"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L59"}},{"id":"def-common.FunctionsRegistry.register","type":"Function","label":"register","signature":["(functionDefinition: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"},")) => void"],"description":[],"children":[{"type":"CompoundType","label":"functionDefinition","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"},")"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L62"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L61"}},{"id":"def-common.FunctionsRegistry.get","type":"Function","label":"get","signature":["(id: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"}," | null"],"description":[],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L67"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L67"}},{"id":"def-common.FunctionsRegistry.toJS","type":"Function","label":"toJS","signature":["() => Record"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L71"}},{"id":"def-common.FunctionsRegistry.toArray","type":"Function","label":"toArray","signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L75"}}],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L58"},"initialIsOpen":false},{"id":"def-common.Executor","type":"Class","label":"Executor","description":[],"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Executor","text":"Executor"}," implements ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.PersistableStateService","text":"PersistableStateService"},"<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},">"],"children":[{"id":"def-common.Executor.createWithDefaults","type":"Function","label":"createWithDefaults","signature":["typeof ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Executor","text":"Executor"},".createWithDefaults"],"description":[],"children":[{"type":"Object","label":"state","isRequired":false,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"}," | undefined"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L83"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L82"}},{"id":"def-common.Executor.state","type":"Object","label":"state","description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":91,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L91"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorContainer","text":"ExecutorContainer"},""]},{"id":"def-common.Executor.functions","type":"Object","label":"functions","description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L96"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.FunctionsRegistry","text":"FunctionsRegistry"}]},{"id":"def-common.Executor.types","type":"Object","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L101"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.TypesRegistry","text":"TypesRegistry"}]},{"id":"def-common.Executor.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"state","isRequired":false,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"}," | undefined"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L103"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L103"}},{"id":"def-common.Executor.registerFunction","type":"Function","label":"registerFunction","signature":["(functionDefinition: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"},")) => void"],"description":[],"children":[{"type":"CompoundType","label":"functionDefinition","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"},")"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L110"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":109,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L109"}},{"id":"def-common.Executor.getFunction","type":"Function","label":"getFunction","signature":["(name: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"}," | undefined"],"description":[],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":118,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L118"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":118,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L118"}},{"id":"def-common.Executor.getFunctions","type":"Function","label":"getFunctions","signature":["() => Record"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":122,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L122"}},{"id":"def-common.Executor.registerType","type":"Function","label":"registerType","signature":["(typeDefinition: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"},")) => void"],"description":[],"children":[{"type":"CompoundType","label":"typeDefinition","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"},")"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":127,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L127"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":126,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L126"}},{"id":"def-common.Executor.getType","type":"Function","label":"getType","signature":["(name: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionType","text":"ExpressionType"}," | undefined"],"description":[],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":135,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L135"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":135,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L135"}},{"id":"def-common.Executor.getTypes","type":"Function","label":"getTypes","signature":["() => Record"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":139,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L139"}},{"id":"def-common.Executor.extendContext","type":"Function","label":"extendContext","signature":["(extraContext: Record) => void"],"description":[],"children":[{"type":"Object","label":"extraContext","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":143,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L143"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":143,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L143"}},{"id":"def-common.Executor.context","type":"Object","label":"context","description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":147,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L147"},"signature":["Record"]},{"id":"def-common.Executor.run","type":"Function","label":"run","signature":["(ast: string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},", input: Input, params?: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionExecutionParams","text":"ExpressionExecutionParams"},") => Promise"],"description":["\nExecute expression and return result.\n"],"children":[{"type":"CompoundType","label":"ast","isRequired":true,"signature":["string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":["Expression AST or a string representing expression."],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":160,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L160"}},{"type":"Uncategorized","label":"input","isRequired":true,"signature":["Input"],"description":["Initial input to the first expression function."],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":161,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L161"}},{"type":"Object","label":"params","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionExecutionParams","text":"ExpressionExecutionParams"}],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":162,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L162"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":159,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L159"}},{"id":"def-common.Executor.createExecution","type":"Function","label":"createExecution","signature":["(ast: string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},", params?: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionExecutionParams","text":"ExpressionExecutionParams"},") => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Execution","text":"Execution"},""],"description":[],"children":[{"type":"CompoundType","label":"ast","isRequired":true,"signature":["string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":170,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L170"}},{"type":"Object","label":"params","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionExecutionParams","text":"ExpressionExecutionParams"}],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":171,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L171"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":169,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L169"}},{"id":"def-common.Executor.inject","type":"Function","label":"inject","signature":["(ast: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},", references: ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[]) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":[],"children":[{"type":"Object","label":"ast","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":217,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L217"}},{"type":"Array","label":"references","isRequired":true,"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[]"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":217,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L217"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":217,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L217"}},{"id":"def-common.Executor.extract","type":"Function","label":"extract","signature":["(ast: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},") => { state: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},"; references: ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[]; }"],"description":[],"children":[{"type":"Object","label":"ast","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":223,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L223"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":223,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L223"}},{"id":"def-common.Executor.telemetry","type":"Function","label":"telemetry","signature":["(ast: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},", telemetryData: Record) => Record"],"description":[],"children":[{"type":"Object","label":"ast","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":233,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L233"}},{"type":"Object","label":"telemetryData","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":233,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L233"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":233,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L233"}},{"id":"def-common.Executor.migrate","type":"Function","label":"migrate","signature":["(ast: ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},", version: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":[],"children":[{"type":"Object","label":"ast","isRequired":true,"signature":[{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.SerializableState","text":"SerializableState"}],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":241,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L241"}},{"type":"string","label":"version","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":241,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L241"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":241,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L241"}},{"id":"def-common.Executor.fork","type":"Function","label":"fork","signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Executor","text":"Executor"},""],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":250,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L250"}}],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L80"},"initialIsOpen":false},{"id":"def-common.Execution","type":"Class","label":"Execution","description":[],"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Execution","text":"Execution"},""],"children":[{"id":"def-common.Execution.state","type":"Object","label":"state","description":["\nDynamic state of the execution."],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L80"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContainer","text":"ExecutionContainer"},">"]},{"id":"def-common.Execution.input","type":"Uncategorized","label":"input","description":["\nInitial input of the execution.\n\nN.B. It is initialized to `null` rather than `undefined` for legacy reasons,\nbecause in legacy interpreter it was set to `null` by default."],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L88"},"signature":["Input"]},{"id":"def-common.Execution.context","type":"Object","label":"context","description":["\nExecution context - object that allows to do side-effects. Context is passed\nto every function."],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L94"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},""]},{"id":"def-common.Execution.contract","type":"Object","label":"contract","description":["\nContract is a public representation of `Execution` instances. Contract we\ncan return to other plugins for their consumption."],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":134,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L134"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContract","text":"ExecutionContract"},""]},{"id":"def-common.Execution.expression","type":"string","label":"expression","description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":140,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L140"}},{"id":"def-common.Execution.result","type":"Object","label":"result","description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":142,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L142"},"signature":["Promise>"]},{"id":"def-common.Execution.inspectorAdapters","type":"Uncategorized","label":"inspectorAdapters","description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":146,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L146"},"signature":["InspectorAdapters"]},{"id":"def-common.Execution.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"execution","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionParams","text":"ExecutionParams"}],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":150,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L150"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":150,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L150"}},{"id":"def-common.Execution.cancel","type":"Function","label":"cancel","signature":["() => void"],"description":["\nStop execution of expression."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":192,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L192"}},{"id":"def-common.Execution.start","type":"Function","label":"start","signature":["(input?: Input) => void"],"description":["\nCall this method to start execution.\n\nN.B. `input` is initialized to `null` rather than `undefined` for legacy reasons,\nbecause in legacy interpreter it was set to `null` by default."],"children":[{"type":"Uncategorized","label":"input","isRequired":true,"signature":["Input"],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":202,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L202"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":202,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L202"}},{"id":"def-common.Execution.invokeChain","type":"Function","label":"invokeChain","signature":["(chainArr: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstFunction","text":"ExpressionAstFunction"},"[], input: unknown) => Promise"],"description":[],"children":[{"type":"Array","label":"chainArr","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstFunction","text":"ExpressionAstFunction"},"[]"],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":236,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L236"}},{"type":"Unknown","label":"input","isRequired":true,"signature":["unknown"],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":236,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L236"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":236,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L236"}},{"id":"def-common.Execution.invokeFunction","type":"Function","label":"invokeFunction","signature":["(fn: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"},", input: unknown, args: Record) => Promise"],"description":[],"children":[{"type":"Object","label":"fn","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"}],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":317,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L317"}},{"type":"Unknown","label":"input","isRequired":true,"signature":["unknown"],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":318,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L318"}},{"type":"Object","label":"args","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":319,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L319"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":316,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L316"}},{"id":"def-common.Execution.cast","type":"Function","label":"cast","signature":["(value: any, toTypeNames?: string[] | undefined) => any"],"description":[],"children":[{"type":"Any","label":"value","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":348,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L348"}},{"type":"Array","label":"toTypeNames","isRequired":false,"signature":["string[] | undefined"],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":348,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L348"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":348,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L348"}},{"id":"def-common.Execution.resolveArgs","type":"Function","label":"resolveArgs","signature":["(fnDef: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"},", input: unknown, argAsts: any) => Promise"],"description":[],"children":[{"type":"Object","label":"fnDef","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"}],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":374,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L374"}},{"type":"Unknown","label":"input","isRequired":true,"signature":["unknown"],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":374,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L374"}},{"type":"Any","label":"argAsts","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":374,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L374"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":374,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L374"}},{"id":"def-common.Execution.interpret","type":"Function","label":"interpret","signature":["(ast: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstNode","text":"ExpressionAstNode"},", input: T) => Promise"],"description":[],"children":[{"type":"CompoundType","label":"ast","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstNode","text":"ExpressionAstNode"}],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":465,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L465"}},{"type":"Uncategorized","label":"input","isRequired":true,"signature":["T"],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":465,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L465"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":465,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L465"}}],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L70"},"initialIsOpen":false},{"id":"def-common.ExecutionContract","type":"Class","label":"ExecutionContract","description":["\n`ExecutionContract` is a wrapper around `Execution` class. It provides the\nsame functionality but does not expose Expressions plugin internals."],"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContract","text":"ExecutionContract"},""],"children":[{"id":"def-common.ExecutionContract.isPending","type":"boolean","label":"isPending","description":[],"source":{"path":"src/plugins/expressions/common/execution/execution_contract.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L18"}},{"id":"def-common.ExecutionContract.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"execution","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Execution","text":"Execution"},""],"description":[],"source":{"path":"src/plugins/expressions/common/execution/execution_contract.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L24"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/execution/execution_contract.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L24"}},{"id":"def-common.ExecutionContract.cancel","type":"Function","children":[],"signature":["() => void"],"description":["\nCancel the execution of the expression. This will set abort signal\n(available in execution context) to aborted state, letting expression\nfunctions to stop their execution."],"label":"cancel","source":{"path":"src/plugins/expressions/common/execution/execution_contract.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L31"},"returnComment":[]},{"id":"def-common.ExecutionContract.getData","type":"Function","children":[],"signature":["() => Promise<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"error\", { error: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ErrorLike","text":"ErrorLike"},"; info?: ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined; }> | Output>"],"description":["\nReturns the final output of expression, if any error happens still\nwraps that error into `ExpressionValueError` type and returns that.\nThis function never throws."],"label":"getData","source":{"path":"src/plugins/expressions/common/execution/execution_contract.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L40"},"returnComment":[]},{"id":"def-common.ExecutionContract.getExpression","type":"Function","children":[],"signature":["() => string"],"description":["\nGet string representation of the expression. Returns the original string\nif execution was started from a string. If execution was started from an\nAST this method returns a string generated from AST."],"label":"getExpression","source":{"path":"src/plugins/expressions/common/execution/execution_contract.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L60"},"returnComment":[]},{"id":"def-common.ExecutionContract.getAst","type":"Function","children":[],"signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":["\nGet AST used to execute the expression."],"label":"getAst","source":{"path":"src/plugins/expressions/common/execution/execution_contract.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L67"},"returnComment":[]},{"id":"def-common.ExecutionContract.inspect","type":"Function","children":[],"signature":["() => InspectorAdapters"],"description":["\nGet Inspector adapters provided to all functions of expression through\nexecution context."],"label":"inspect","source":{"path":"src/plugins/expressions/common/execution/execution_contract.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L73"},"returnComment":[]}],"source":{"path":"src/plugins/expressions/common/execution/execution_contract.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution_contract.ts#L17"},"initialIsOpen":false},{"id":"def-common.ExpressionsService","type":"Class","label":"ExpressionsService","description":["\n`ExpressionsService` class is used for multiple purposes:\n\n1. It implements the same Expressions service that can be used on both:\n (1) server-side and (2) browser-side.\n2. It implements the same Expressions service that users can fork/clone,\n thus have their own instance of the Expressions plugin.\n3. `ExpressionsService` defines the public contracts of *setup* and *start*\n Kibana Platform life-cycles for ease-of-use on server-side and browser-side.\n4. `ExpressionsService` creates a bound version of all exported contract functions.\n5. Functions are bound the way there are:\n\n ```ts\n registerFunction = (...args: Parameters\n ): ReturnType => this.executor.registerFunction(...args);\n ```\n\n so that JSDoc appears in developers IDE when they use those `plugins.expressions.registerFunction(`."],"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionsService","text":"ExpressionsService"}," implements ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.PersistableStateService","text":"PersistableStateService"},"<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},">"],"children":[{"id":"def-common.ExpressionsService.executor","type":"Object","label":"executor","description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":175,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L175"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Executor","text":"Executor"},">"]},{"id":"def-common.ExpressionsService.renderers","type":"Object","label":"renderers","description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":176,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L176"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRendererRegistry","text":"ExpressionRendererRegistry"}]},{"id":"def-common.ExpressionsService.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"{\n executor = Executor.createWithDefaults(),\n renderers = new ExpressionRendererRegistry(),\n }","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionServiceParams","text":"ExpressionServiceParams"}],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":178,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L178"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":178,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L178"}},{"id":"def-common.ExpressionsService.registerFunction","type":"Function","children":[{"type":"CompoundType","label":"functionDefinition","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"},")"],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":219,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L219"}}],"signature":["(functionDefinition: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"},")) => void"],"description":["\nRegister an expression function, which will be possible to execute as\npart of the expression pipeline.\n\nBelow we register a function which simply sleeps for given number of\nmilliseconds to delay the execution and outputs its input as-is.\n\n```ts\nexpressions.registerFunction({\n name: 'sleep',\n args: {\n time: {\n aliases: ['_'],\n help: 'Time in milliseconds for how long to sleep',\n types: ['number'],\n },\n },\n help: '',\n fn: async (input, args, context) => {\n await new Promise(r => setTimeout(r, args.time));\n return input;\n },\n}\n```\n\nThe actual function is defined in the `fn` key. The function can be *async*.\nIt receives three arguments: (1) `input` is the output of the previous function\nor the initial input of the expression if the function is first in chain;\n(2) `args` are function arguments as defined in expression string, that can\nbe edited by user (e.g in case of Canvas); (3) `context` is a shared object\npassed to all functions that can be used for side-effects."],"label":"registerFunction","source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":218,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L218"},"returnComment":[]},{"id":"def-common.ExpressionsService.registerType","type":"Function","children":[{"type":"CompoundType","label":"typeDefinition","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"},")"],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":223,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L223"}}],"signature":["(typeDefinition: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"},")) => void"],"description":[],"label":"registerType","source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":222,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L222"},"returnComment":[]},{"id":"def-common.ExpressionsService.registerRenderer","type":"Function","children":[{"type":"CompoundType","label":"definition","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionRenderDefinition","text":"AnyExpressionRenderDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionRenderDefinition","text":"AnyExpressionRenderDefinition"},")"],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":227,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L227"}}],"signature":["(definition: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionRenderDefinition","text":"AnyExpressionRenderDefinition"}," | (() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionRenderDefinition","text":"AnyExpressionRenderDefinition"},")) => void"],"description":[],"label":"registerRenderer","source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":226,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L226"},"returnComment":[]},{"id":"def-common.ExpressionsService.run","type":"Function","children":[{"type":"CompoundType","label":"ast","isRequired":true,"signature":["string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":230,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L230"}},{"type":"Uncategorized","label":"input","isRequired":true,"signature":["Input"],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":230,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L230"}},{"type":"Object","label":"params","isRequired":false,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionExecutionParams","text":"ExpressionExecutionParams"}," | undefined"],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":230,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L230"}}],"signature":["(ast: string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},", input: Input, params: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionExecutionParams","text":"ExpressionExecutionParams"}," | undefined) => Promise"],"description":[],"label":"run","source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":230,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L230"},"returnComment":[]},{"id":"def-common.ExpressionsService.getFunction","type":"Function","children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":233,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L233"}}],"signature":["(name: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"}," | undefined"],"description":[],"label":"getFunction","source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":233,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L233"},"returnComment":[]},{"id":"def-common.ExpressionsService.getFunctions","type":"Function","children":[],"signature":["() => Record"],"description":["\nReturns POJO map of all registered expression functions, where keys are\nnames of the functions and values are `ExpressionFunction` instances."],"label":"getFunctions","source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":240,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L240"},"returnComment":[]},{"id":"def-common.ExpressionsService.getRenderer","type":"Function","children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":243,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L243"}}],"signature":["(name: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRenderer","text":"ExpressionRenderer"}," | null"],"description":[],"label":"getRenderer","source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":243,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L243"},"returnComment":[]},{"id":"def-common.ExpressionsService.getRenderers","type":"Function","children":[],"signature":["() => Record>"],"description":["\nReturns POJO map of all registered expression renderers, where keys are\nnames of the renderers and values are `ExpressionRenderer` instances."],"label":"getRenderers","source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":250,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L250"},"returnComment":[]},{"id":"def-common.ExpressionsService.getType","type":"Function","children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":253,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L253"}}],"signature":["(name: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionType","text":"ExpressionType"}," | undefined"],"description":[],"label":"getType","source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":253,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L253"},"returnComment":[]},{"id":"def-common.ExpressionsService.getTypes","type":"Function","children":[],"signature":["() => Record"],"description":["\nReturns POJO map of all registered expression types, where keys are\nnames of the types and values are `ExpressionType` instances."],"label":"getTypes","source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":260,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L260"},"returnComment":[]},{"id":"def-common.ExpressionsService.execute","type":"Function","label":"execute","description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":262,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L262"},"signature":["(ast: string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},", input: Input, params?: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionExecutionParams","text":"ExpressionExecutionParams"}," | undefined) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContract","text":"ExecutionContract"},""]},{"id":"def-common.ExpressionsService.fork","type":"Function","children":[],"signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionsService","text":"ExpressionsService"}],"description":[],"label":"fork","source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":268,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L268"},"returnComment":[]},{"id":"def-common.ExpressionsService.telemetry","type":"Function","children":[{"type":"Object","label":"state","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":281,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L281"}},{"type":"Object","label":"telemetryData","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":282,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L282"}}],"signature":["(state: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},", telemetryData?: Record) => Record"],"description":["\nExtracts telemetry from expression AST"],"label":"telemetry","source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":280,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L280"},"returnComment":[]},{"id":"def-common.ExpressionsService.extract","type":"Function","children":[{"type":"Object","label":"state","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":292,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L292"}}],"signature":["(state: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},") => { state: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},"; references: ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[]; }"],"description":["\nExtracts saved object references from expression AST"],"label":"extract","source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":292,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L292"},"returnComment":["new expression AST with references removed and array of references"]},{"id":"def-common.ExpressionsService.inject","type":"Function","children":[{"type":"Object","label":"state","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":302,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L302"}},{"type":"Array","label":"references","isRequired":true,"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[]"],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":302,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L302"}}],"signature":["(state: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},", references: ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObjectReference","text":"SavedObjectReference"},"[]) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":["\nInjects saved object references into expression AST"],"label":"inject","source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":302,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L302"},"returnComment":["new expression AST with references injected"]},{"id":"def-common.ExpressionsService.migrate","type":"Function","children":[{"type":"Object","label":"state","isRequired":true,"signature":[{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.SerializableState","text":"SerializableState"}],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":312,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L312"}},{"type":"string","label":"version","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":312,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L312"}}],"signature":["(state: ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},", version: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":["\nRuns the migration (if it exists) for specified version. This will run a single migration step (ie from 7.10.0 to 7.10.1)"],"label":"migrate","source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":312,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L312"},"returnComment":["new migrated expression AST"]},{"id":"def-common.ExpressionsService.setup","type":"Function","label":"setup","signature":["() => Pick<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionsService","text":"ExpressionsService"},", \"getType\" | \"getFunction\" | \"getFunctions\" | \"getRenderer\" | \"getRenderers\" | \"getTypes\" | \"registerFunction\" | \"registerRenderer\" | \"registerType\" | \"run\" | \"fork\">"],"description":["\nReturns Kibana Platform *setup* life-cycle contract. Useful to return the\nsame contract on server-side and browser-side."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":320,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L320"}},{"id":"def-common.ExpressionsService.start","type":"Function","label":"start","signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionsServiceStart","text":"ExpressionsServiceStart"}],"description":["\nReturns Kibana Platform *start* life-cycle contract. Useful to return the\nsame contract on server-side and browser-side."],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":328,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L328"}},{"id":"def-common.ExpressionsService.stop","type":"Function","label":"stop","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":332,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L332"}}],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":174,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L174"},"initialIsOpen":false},{"id":"def-common.TablesAdapter","type":"Class","label":"TablesAdapter","description":[],"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.TablesAdapter","text":"TablesAdapter"}," extends ","EventEmitter"],"children":[{"id":"def-common.TablesAdapter.logDatatable","type":"Function","label":"logDatatable","signature":["(name: string, datatable: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"},") => void"],"description":[],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/util/tables_adapter.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/tables_adapter.ts#L15"}},{"type":"Object","label":"datatable","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"}],"description":[],"source":{"path":"src/plugins/expressions/common/util/tables_adapter.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/tables_adapter.ts#L15"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/util/tables_adapter.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/tables_adapter.ts#L15"}},{"id":"def-common.TablesAdapter.tables","type":"Object","label":"tables","description":[],"source":{"path":"src/plugins/expressions/common/util/tables_adapter.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/tables_adapter.ts#L20"},"signature":["{ [key: string]: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"},"; }"]}],"source":{"path":"src/plugins/expressions/common/util/tables_adapter.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/tables_adapter.ts#L12"},"initialIsOpen":false},{"id":"def-common.ExpressionsInspectorAdapter","type":"Class","label":"ExpressionsInspectorAdapter","description":[],"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionsInspectorAdapter","text":"ExpressionsInspectorAdapter"}," extends ","EventEmitter"],"children":[{"id":"def-common.ExpressionsInspectorAdapter.logAST","type":"Function","label":"logAST","signature":["(ast: any) => void"],"description":[],"children":[{"type":"Any","label":"ast","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/util/expressions_inspector_adapter.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/expressions_inspector_adapter.ts#L14"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/util/expressions_inspector_adapter.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/expressions_inspector_adapter.ts#L14"}},{"id":"def-common.ExpressionsInspectorAdapter.ast","type":"Any","label":"ast","description":[],"source":{"path":"src/plugins/expressions/common/util/expressions_inspector_adapter.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/expressions_inspector_adapter.ts#L19"},"signature":["any"]}],"source":{"path":"src/plugins/expressions/common/util/expressions_inspector_adapter.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/expressions_inspector_adapter.ts#L11"},"initialIsOpen":false}],"functions":[{"id":"def-common.isExpressionAstBuilder","type":"Function","label":"isExpressionAstBuilder","signature":["(val: any) => boolean"],"description":["\nType guard that checks whether a given value is an\n`ExpressionAstExpressionBuilder`. This is useful when working\nwith subexpressions, where you might be retrieving a function\nargument, and need to know whether it is an expression builder\ninstance which you can perform operations on.\n"],"children":[{"type":"Any","label":"val","isRequired":true,"signature":["any"],"description":["Value you want to check."],"source":{"path":"src/plugins/expressions/common/ast/build_expression.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L35"}}],"tags":["example","return"],"returnComment":["boolean"],"source":{"path":"src/plugins/expressions/common/ast/build_expression.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L35"},"initialIsOpen":false},{"id":"def-common.buildExpression","type":"Function","label":"buildExpression","signature":["(initialState: string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}," | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstFunctionBuilder","text":"ExpressionAstFunctionBuilder"},"<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"},">[] | undefined) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpressionBuilder","text":"ExpressionAstExpressionBuilder"}],"description":["\nMakes it easy to progressively build, update, and traverse an\nexpression AST. You can either start with an empty AST, or\nprovide an expression string, AST, or array of expression\nfunction builders to use as initial state.\n"],"children":[{"type":"CompoundType","label":"initialState","isRequired":false,"signature":["string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}," | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstFunctionBuilder","text":"ExpressionAstFunctionBuilder"},"<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"},">[] | undefined"],"description":["Optional. An expression string, AST, or array of `ExpressionAstFunctionBuilder[]`."],"source":{"path":"src/plugins/expressions/common/ast/build_expression.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L98"}}],"tags":["return"],"returnComment":["`this`"],"source":{"path":"src/plugins/expressions/common/ast/build_expression.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L97"},"initialIsOpen":false},{"id":"def-common.buildExpressionFunction","type":"Function","label":"buildExpressionFunction","signature":["(fnName: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.InferFunctionDefinition","text":"InferFunctionDefinition"},"[\"name\"], initialArgs: { [K in keyof FunctionArgs]: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpressionBuilder","text":"ExpressionAstExpressionBuilder"}," | FunctionArgs[K] | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpressionBuilder","text":"ExpressionAstExpressionBuilder"},"[]; }) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstFunctionBuilder","text":"ExpressionAstFunctionBuilder"},""],"description":["\nManages an AST for a single expression function. The return value\ncan be provided to `buildExpression` to add this function to an\nexpression.\n\nNote that to preserve type safety and ensure no args are missing,\nall required arguments for the specified function must be provided\nup front. If desired, they can be changed or removed later.\n"],"children":[{"type":"Uncategorized","label":"fnName","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.InferFunctionDefinition","text":"InferFunctionDefinition"},"[\"name\"]"],"description":["String representing the name of this expression function."],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":155,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L155"}},{"type":"Object","label":"initialArgs","isRequired":true,"signature":["{ [K in keyof FunctionArgs]: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpressionBuilder","text":"ExpressionAstExpressionBuilder"}," | FunctionArgs[K] | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpressionBuilder","text":"ExpressionAstExpressionBuilder"},"[]; }"],"description":["Object containing the arguments to this function."],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":163,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L163"}}],"tags":["return"],"returnComment":["`this`"],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":152,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L152"},"initialIsOpen":false},{"id":"def-common.formatExpression","type":"Function","label":"formatExpression","signature":["(ast: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},") => string"],"description":["\nGiven expression pipeline AST, returns formatted string.\n"],"children":[{"type":"Object","label":"ast","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":["Expression pipeline AST."],"source":{"path":"src/plugins/expressions/common/ast/format_expression.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/format_expression.ts#L17"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/ast/format_expression.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/format_expression.ts#L17"},"initialIsOpen":false},{"id":"def-common.format","type":"Function","label":"format","signature":["(ast: T, type: T extends ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}," ? \"expression\" : \"argument\") => string"],"description":[],"children":[{"type":"Uncategorized","label":"ast","isRequired":true,"signature":["T"],"description":[],"source":{"path":"src/plugins/expressions/common/ast/format.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/format.ts#L15"}},{"type":"Uncategorized","label":"type","isRequired":true,"signature":["T extends ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}," ? \"expression\" : \"argument\""],"description":[],"source":{"path":"src/plugins/expressions/common/ast/format.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/format.ts#L16"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/ast/format.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/format.ts#L14"},"initialIsOpen":false},{"id":"def-common.parseExpression","type":"Function","label":"parseExpression","signature":["(expression: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"description":["\nGiven expression pipeline string, returns parsed AST.\n"],"children":[{"type":"string","label":"expression","isRequired":true,"signature":["string"],"description":["Expression pipeline string."],"source":{"path":"src/plugins/expressions/common/ast/parse_expression.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/parse_expression.ts#L17"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/ast/parse_expression.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/parse_expression.ts#L17"},"initialIsOpen":false},{"id":"def-common.parse","type":"Function","label":"parse","signature":["(expression: E, startRule: S) => S extends \"expression\" ? ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}," : ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstArgument","text":"ExpressionAstArgument"}],"description":[],"children":[{"type":"Uncategorized","label":"expression","isRequired":true,"signature":["E"],"description":[],"source":{"path":"src/plugins/expressions/common/ast/parse.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/parse.ts#L15"}},{"type":"Uncategorized","label":"startRule","isRequired":true,"signature":["S"],"description":[],"source":{"path":"src/plugins/expressions/common/ast/parse.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/parse.ts#L16"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/ast/parse.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/parse.ts#L14"},"initialIsOpen":false},{"id":"def-common.getType","type":"Function","label":"getType","signature":["(node: any) => any"],"description":[],"children":[{"type":"Any","label":"node","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/get_type.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/get_type.ts#L9"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_types/get_type.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/get_type.ts#L9"},"initialIsOpen":false},{"id":"def-common.serializeProvider","type":"Function","children":[{"type":"Object","label":"types","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/serialize_provider.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/serialize_provider.ts#L15"}}],"signature":["(types: Record) => { serialize: (value: any) => any; deserialize: (value: any) => any; }"],"description":[],"label":"serializeProvider","source":{"path":"src/plugins/expressions/common/expression_types/serialize_provider.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/serialize_provider.ts#L15"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.isDatatable","type":"Function","children":[{"type":"Unknown","label":"datatable","isRequired":true,"signature":["unknown"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L29"}}],"signature":["(datatable: unknown) => datatable is ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"}],"description":["\nA Utility function that Typescript can use to determine if an object is a Datatable."],"label":"isDatatable","source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L29"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.isExpressionValueError","type":"Function","children":[{"type":"Any","label":"value","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/error.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/error.ts#L25"}}],"signature":["(value: any) => value is ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"error\", { error: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ErrorLike","text":"ErrorLike"},"; info?: ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined; }>"],"description":[],"label":"isExpressionValueError","source":{"path":"src/plugins/expressions/common/expression_types/specs/error.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/error.ts#L25"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getBucketIdentifier","type":"Function","label":"getBucketIdentifier","signature":["(row: Record, groupColumns: string[] | undefined) => string"],"description":["\nReturns a string identifying the group of a row by a list of columns to group by"],"children":[{"type":"Object","label":"row","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/series_calculation_helpers.ts#L15"}},{"type":"Array","label":"groupColumns","isRequired":false,"signature":["string[] | undefined"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/series_calculation_helpers.ts#L15"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/series_calculation_helpers.ts#L15"},"initialIsOpen":false},{"id":"def-common.buildResultColumns","type":"Function","label":"buildResultColumns","signature":["(input: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"},", outputColumnId: string, inputColumnId: string, outputColumnName: string | undefined, options: { allowColumnOverwrite: boolean; }) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.DatatableColumn","text":"DatatableColumn"},"[] | undefined"],"description":["\nChecks whether input and output columns are defined properly\nand builds column array of the output table if that's the case.\n\n* Throws an error if the output column exists already.\n* Returns undefined if the input column doesn't exist."],"children":[{"type":"Object","label":"input","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"}],"description":["Input datatable"],"source":{"path":"src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/series_calculation_helpers.ts#L34"}},{"type":"string","label":"outputColumnId","isRequired":true,"signature":["string"],"description":["Id of the output column"],"source":{"path":"src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/series_calculation_helpers.ts#L35"}},{"type":"string","label":"inputColumnId","isRequired":true,"signature":["string"],"description":["Id of the input column"],"source":{"path":"src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/series_calculation_helpers.ts#L36"}},{"type":"string","label":"outputColumnName","isRequired":false,"signature":["string | undefined"],"description":["Optional name of the output column"],"source":{"path":"src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/series_calculation_helpers.ts#L37"}},{"id":"def-common.buildResultColumns.options","type":"Object","label":"options","description":[],"children":[{"id":"def-common.buildResultColumns.options.allowColumnOverwrite","type":"boolean","label":"allowColumnOverwrite","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/series_calculation_helpers.ts#L38"}}],"source":{"path":"src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/series_calculation_helpers.ts#L38"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_functions/series_calculation_helpers.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/series_calculation_helpers.ts#L33"},"initialIsOpen":false},{"id":"def-common.createExecutorContainer","type":"Function","children":[{"type":"Object","label":"state","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"},""],"description":[],"source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L62"}}],"signature":[" = Record>(state?: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"},") => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorContainer","text":"ExecutorContainer"},""],"description":[],"label":"createExecutorContainer","source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L59"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.createExecutionContainer","type":"Function","children":[{"type":"Object","label":"state","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionState","text":"ExecutionState"},""],"description":[],"source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L81"}}],"signature":["(state?: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionState","text":"ExecutionState"},") => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContainer","text":"ExecutionContainer"},""],"description":[],"label":"createExecutionContainer","source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L80"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.createError","type":"Function","children":[{"type":"CompoundType","label":"err","isRequired":true,"signature":["string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ErrorLike","text":"ErrorLike"}],"description":[],"source":{"path":"src/plugins/expressions/common/util/create_error.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/create_error.ts#L21"}}],"signature":["(err: string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ErrorLike","text":"ErrorLike"},") => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"error\", { error: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ErrorLike","text":"ErrorLike"},"; info?: ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined; }>"],"description":[],"label":"createError","source":{"path":"src/plugins/expressions/common/util/create_error.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/create_error.ts#L21"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.getByAlias","type":"Function","label":"getByAlias","signature":["(node: T[] | Record, nodeName: string) => T | undefined"],"description":["\nThis is used for looking up function/argument definitions. It looks through\nthe given object/array for a case-insensitive match, which could be either the\n`name` itself, or something under the `aliases` property."],"children":[{"type":"CompoundType","label":"node","isRequired":true,"signature":["T[] | Record"],"description":[],"source":{"path":"src/plugins/expressions/common/util/get_by_alias.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/get_by_alias.ts#L15"}},{"type":"string","label":"nodeName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/util/get_by_alias.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/get_by_alias.ts#L16"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/util/get_by_alias.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/util/get_by_alias.ts#L14"},"initialIsOpen":false}],"interfaces":[{"id":"def-common.SerializedFieldFormat","type":"Interface","label":"SerializedFieldFormat","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializedFieldFormat","text":"SerializedFieldFormat"},""],"description":["\nJSON representation of a field formatter configuration.\nIs used to carry information about how to format data in\na data table as part of the column definition."],"children":[{"id":"def-common.SerializedFieldFormat.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/expressions/common/types/common.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L54"},"signature":["string | undefined"]},{"id":"def-common.SerializedFieldFormat.params","type":"Uncategorized","label":"params","description":[],"source":{"path":"src/plugins/expressions/common/types/common.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L55"},"signature":["TParams | undefined"]}],"source":{"path":"src/plugins/expressions/common/types/common.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L53"},"initialIsOpen":false},{"id":"def-common.CSSStyle","type":"Interface","label":"CSSStyle","description":["\nRepresents the various style properties that can be applied to an element."],"children":[{"id":"def-common.CSSStyle.color","type":"string","label":"color","description":[],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":91,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L91"},"signature":["string | undefined"]},{"id":"def-common.CSSStyle.fill","type":"string","label":"fill","description":[],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L92"},"signature":["string | undefined"]},{"id":"def-common.CSSStyle.fontFamily","type":"CompoundType","label":"fontFamily","description":[],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":93,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L93"},"signature":["\"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Lucida Grande\" | \"Myriad\" | \"Open Sans\" | \"Optima\" | \"Palatino\" | undefined"]},{"id":"def-common.CSSStyle.fontSize","type":"string","label":"fontSize","description":[],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L94"},"signature":["string | undefined"]},{"id":"def-common.CSSStyle.fontStyle","type":"CompoundType","label":"fontStyle","description":[],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L95"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.FontStyle","text":"FontStyle"}," | undefined"]},{"id":"def-common.CSSStyle.fontWeight","type":"CompoundType","label":"fontWeight","description":[],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L96"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.FontWeight","text":"FontWeight"}," | undefined"]},{"id":"def-common.CSSStyle.lineHeight","type":"CompoundType","label":"lineHeight","description":[],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L97"},"signature":["string | number | undefined"]},{"id":"def-common.CSSStyle.textAlign","type":"CompoundType","label":"textAlign","description":[],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L98"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.TextAlignment","text":"TextAlignment"}," | undefined"]},{"id":"def-common.CSSStyle.textDecoration","type":"CompoundType","label":"textDecoration","description":[],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L99"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.TextDecoration","text":"TextDecoration"}," | undefined"]}],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L90"},"initialIsOpen":false},{"id":"def-common.ContainerStyle","type":"Interface","label":"ContainerStyle","description":["\nRepresents an object containing style information for a Container."],"children":[{"id":"def-common.ContainerStyle.border","type":"CompoundType","label":"border","description":[],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":106,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L106"},"signature":["string | null"]},{"id":"def-common.ContainerStyle.borderRadius","type":"CompoundType","label":"borderRadius","description":[],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":107,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L107"},"signature":["string | null"]},{"id":"def-common.ContainerStyle.padding","type":"CompoundType","label":"padding","description":[],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L108"},"signature":["string | null"]},{"id":"def-common.ContainerStyle.backgroundColor","type":"CompoundType","label":"backgroundColor","description":[],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":109,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L109"},"signature":["string | null"]},{"id":"def-common.ContainerStyle.backgroundImage","type":"CompoundType","label":"backgroundImage","description":[],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L110"},"signature":["string | null"]},{"id":"def-common.ContainerStyle.backgroundSize","type":"Enum","label":"backgroundSize","description":[],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":111,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L111"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.BackgroundSize","text":"BackgroundSize"}]},{"id":"def-common.ContainerStyle.backgroundRepeat","type":"Enum","label":"backgroundRepeat","description":[],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":112,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L112"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.BackgroundRepeat","text":"BackgroundRepeat"}]},{"id":"def-common.ContainerStyle.opacity","type":"CompoundType","label":"opacity","description":[],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":113,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L113"},"signature":["number | null"]},{"id":"def-common.ContainerStyle.overflow","type":"Enum","label":"overflow","description":[],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":114,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L114"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Overflow","text":"Overflow"}]}],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":105,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L105"},"initialIsOpen":false},{"id":"def-common.ExpressionTypeStyle","type":"Interface","label":"ExpressionTypeStyle","description":["\nAn object that represents style information, typically CSS."],"children":[{"id":"def-common.ExpressionTypeStyle.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":121,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L121"},"signature":["\"style\""]},{"id":"def-common.ExpressionTypeStyle.spec","type":"Object","label":"spec","description":[],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":122,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L122"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.CSSStyle","text":"CSSStyle"}]},{"id":"def-common.ExpressionTypeStyle.css","type":"string","label":"css","description":[],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":123,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L123"}}],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":120,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L120"},"initialIsOpen":false},{"id":"def-common.IRegistry","type":"Interface","label":"IRegistry","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.IRegistry","text":"IRegistry"},""],"description":[],"children":[{"id":"def-common.IRegistry.get","type":"Function","label":"get","signature":["(id: string) => T | null"],"description":[],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/types/registry.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/registry.ts#L10"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/types/registry.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/registry.ts#L10"}},{"id":"def-common.IRegistry.toJS","type":"Function","label":"toJS","signature":["() => Record"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/types/registry.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/registry.ts#L12"}},{"id":"def-common.IRegistry.toArray","type":"Function","label":"toArray","signature":["() => T[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/types/registry.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/registry.ts#L14"}}],"source":{"path":"src/plugins/expressions/common/types/registry.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/registry.ts#L9"},"initialIsOpen":false},{"id":"def-common.ExpressionAstExpressionBuilder","type":"Interface","label":"ExpressionAstExpressionBuilder","description":[],"children":[{"id":"def-common.ExpressionAstExpressionBuilder.type","type":"string","label":"type","description":["\nUsed to identify expression builder objects."],"source":{"path":"src/plugins/expressions/common/ast/build_expression.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L48"},"signature":["\"expression_builder\""]},{"id":"def-common.ExpressionAstExpressionBuilder.functions","type":"Array","label":"functions","description":["\nArray of each of the `buildExpressionFunction()` instances\nin this expression. Use this to remove or reorder functions\nin the expression."],"source":{"path":"src/plugins/expressions/common/ast/build_expression.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L54"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstFunctionBuilder","text":"ExpressionAstFunctionBuilder"},"<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"},">[]"]},{"id":"def-common.ExpressionAstExpressionBuilder.findFunction","type":"Function","label":"findFunction","description":["\nRecursively searches expression for all ocurrences of the\nfunction, including in subexpressions.\n\nUseful when performing migrations on a specific function,\nas you can iterate over the array of references and update\nall functions at once.\n"],"source":{"path":"src/plugins/expressions/common/ast/build_expression.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L66"},"signature":["(fnName: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.InferFunctionDefinition","text":"InferFunctionDefinition"},"[\"name\"]) => [] | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstFunctionBuilder","text":"ExpressionAstFunctionBuilder"},"[]"]},{"id":"def-common.ExpressionAstExpressionBuilder.toAst","type":"Function","label":"toAst","description":["\nConverts expression to an AST.\n"],"source":{"path":"src/plugins/expressions/common/ast/build_expression.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L74"},"signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}]},{"id":"def-common.ExpressionAstExpressionBuilder.toString","type":"Function","label":"toString","description":["\nConverts expression to an expression string.\n"],"source":{"path":"src/plugins/expressions/common/ast/build_expression.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L80"},"signature":["() => string"]}],"source":{"path":"src/plugins/expressions/common/ast/build_expression.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_expression.ts#L44"},"initialIsOpen":false},{"id":"def-common.ExpressionAstFunctionBuilder","type":"Interface","label":"ExpressionAstFunctionBuilder","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstFunctionBuilder","text":"ExpressionAstFunctionBuilder"},""],"description":[],"children":[{"id":"def-common.ExpressionAstFunctionBuilder.type","type":"string","label":"type","description":["\nUsed to identify expression function builder objects."],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L63"},"signature":["\"expression_function_builder\""]},{"id":"def-common.ExpressionAstFunctionBuilder.name","type":"Uncategorized","label":"name","description":["\nName of this expression function."],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L67"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.InferFunctionDefinition","text":"InferFunctionDefinition"},"[\"name\"]"]},{"id":"def-common.ExpressionAstFunctionBuilder.arguments","type":"Object","label":"arguments","description":["\nObject of all args currently added to the function. This is\nstructured similarly to `ExpressionAstFunction['arguments']`,\nhowever any subexpressions are returned as expression builder\ninstances instead of expression ASTs."],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L74"},"signature":["FunctionBuilderArguments"]},{"id":"def-common.ExpressionAstFunctionBuilder.addArgument","type":"Function","label":"addArgument","description":["\nAdds an additional argument to the function. For multi-args,\nthis should be called once for each new arg. Note that TS\nwill not enforce whether multi-args are available, so only\nuse this to update an existing arg if you are certain it\nis a multi-arg.\n"],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L86"},"signature":[">(name: A, value: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpressionBuilder","text":"ExpressionAstExpressionBuilder"}," | FunctionArgs[A]) => this"]},{"id":"def-common.ExpressionAstFunctionBuilder.getArgument","type":"Function","label":"getArgument","description":["\nRetrieves an existing argument by name.\nUseful when you want to retrieve the current array of args and add\nsomething to it before calling `replaceArgument`. Any subexpression\narguments will be returned as expression builder instances.\n"],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L99"},"signature":[">(name: A) => (",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpressionBuilder","text":"ExpressionAstExpressionBuilder"}," | FunctionArgs[A])[] | undefined"]},{"id":"def-common.ExpressionAstFunctionBuilder.replaceArgument","type":"Function","label":"replaceArgument","description":["\nOverwrites an existing argument with a new value.\nIn order to support multi-args, the value given must always be\nan array.\n"],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":111,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L111"},"signature":[">(name: A, value: (",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpressionBuilder","text":"ExpressionAstExpressionBuilder"}," | FunctionArgs[A])[]) => this"]},{"id":"def-common.ExpressionAstFunctionBuilder.removeArgument","type":"Function","label":"removeArgument","description":["\nRemoves an (optional) argument from the function.\n\nTypeScript will enforce that you only remove optional\narguments. For manipulating required args, use `replaceArgument`.\n"],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":124,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L124"},"signature":[">>(name: A) => this"]},{"id":"def-common.ExpressionAstFunctionBuilder.toAst","type":"Function","label":"toAst","description":["\nConverts function to an AST.\n"],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":130,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L130"},"signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstFunction","text":"ExpressionAstFunction"}]},{"id":"def-common.ExpressionAstFunctionBuilder.toString","type":"Function","label":"toString","description":["\nConverts function to an expression string.\n"],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":136,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L136"},"signature":["() => string"]}],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L57"},"initialIsOpen":false},{"id":"def-common.Font","type":"Interface","label":"Font","description":["\nAn interface representing a font in Canvas, with a textual label and the CSS\n`font-value`."],"children":[{"id":"def-common.Font.label","type":"CompoundType","label":"label","description":[],"source":{"path":"src/plugins/expressions/common/fonts.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L26"},"signature":["\"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Lucida Grande\" | \"Myriad\" | \"Open Sans\" | \"Optima\" | \"Palatino\""]},{"id":"def-common.Font.value","type":"CompoundType","label":"value","description":[],"source":{"path":"src/plugins/expressions/common/fonts.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L27"},"signature":["\"'American Typewriter', 'Courier New', Courier, Monaco, mono\" | \"Arial, sans-serif\" | \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Brush Script MT', 'Comic Sans', sans-serif\" | \"Chalkboard, 'Comic Sans', sans-serif\" | \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"Futura, Impact, Helvetica, Arial, sans-serif\" | \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"'Helvetica Neue', Helvetica, Arial, sans-serif\" | \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\" | \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\" | \"Myriad, Helvetica, Arial, sans-serif\" | \"'Open Sans', Helvetica, Arial, sans-serif\" | \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\""]}],"source":{"path":"src/plugins/expressions/common/fonts.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L25"},"initialIsOpen":false},{"id":"def-common.ExpressionTypeDefinition","type":"Interface","label":"ExpressionTypeDefinition","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionTypeDefinition","text":"ExpressionTypeDefinition"},""],"description":["\nA generic type which represents a custom Expression Type Definition that's\nregistered to the Interpreter."],"children":[{"id":"def-common.ExpressionTypeDefinition.name","type":"Uncategorized","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L31"},"signature":["Name"]},{"id":"def-common.ExpressionTypeDefinition.validate","type":"Function","label":"validate","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L32"},"signature":["((type: any) => void | Error) | undefined"]},{"id":"def-common.ExpressionTypeDefinition.serialize","type":"Function","label":"serialize","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L33"},"signature":["((type: Value) => SerializedType) | undefined"]},{"id":"def-common.ExpressionTypeDefinition.deserialize","type":"Function","label":"deserialize","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L34"},"signature":["((type: SerializedType) => Value) | undefined"]},{"id":"def-common.ExpressionTypeDefinition.from","type":"Object","label":"from","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L37"},"signature":["{ [type: string]: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueConverter","text":"ExpressionValueConverter"},"; } | undefined"]},{"id":"def-common.ExpressionTypeDefinition.to","type":"Object","label":"to","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L40"},"signature":["{ [type: string]: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueConverter","text":"ExpressionValueConverter"},"; } | undefined"]},{"id":"def-common.ExpressionTypeDefinition.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L43"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L26"},"initialIsOpen":false},{"id":"def-common.SerializableState","type":"Interface","label":"SerializableState","description":[],"children":[{"id":"def-common.SerializableState.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L20"},"signature":["any"]}],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L19"},"initialIsOpen":false},{"id":"def-common.DatatableColumnMeta","type":"Interface","label":"DatatableColumnMeta","description":["\nDatatable column meta information"],"children":[{"id":"def-common.DatatableColumnMeta.type","type":"CompoundType","label":"type","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L63"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.DatatableColumnType","text":"DatatableColumnType"}]},{"id":"def-common.DatatableColumnMeta.field","type":"string","label":"field","description":["\nfield this column is based on"],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L67"},"signature":["string | undefined"]},{"id":"def-common.DatatableColumnMeta.index","type":"string","label":"index","description":["\nindex/table this column is based on"],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L71"},"signature":["string | undefined"]},{"id":"def-common.DatatableColumnMeta.params","type":"Object","label":"params","description":["\nserialized field format"],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L75"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializedFieldFormat","text":"SerializedFieldFormat"},"> | undefined"]},{"id":"def-common.DatatableColumnMeta.source","type":"string","label":"source","description":["\nsource function that produced this column"],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L79"},"signature":["string | undefined"]},{"id":"def-common.DatatableColumnMeta.sourceParams","type":"Object","label":"sourceParams","description":["\nany extra parameters for the source that produced this column"],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L83"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined"]}],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L62"},"initialIsOpen":false},{"id":"def-common.DatatableColumn","type":"Interface","label":"DatatableColumn","description":["\nThis type represents the shape of a column in a `Datatable`."],"children":[{"id":"def-common.DatatableColumn.id","type":"string","label":"id","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L90"}},{"id":"def-common.DatatableColumn.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":91,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L91"}},{"id":"def-common.DatatableColumn.meta","type":"Object","label":"meta","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L92"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.DatatableColumnMeta","text":"DatatableColumnMeta"}]}],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L89"},"initialIsOpen":false},{"id":"def-common.Datatable","type":"Interface","label":"Datatable","description":["\nA `Datatable` in Canvas is a unique structure that represents tabulated data."],"children":[{"id":"def-common.Datatable.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L99"},"signature":["\"datatable\""]},{"id":"def-common.Datatable.columns","type":"Array","label":"columns","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":100,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L100"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.DatatableColumn","text":"DatatableColumn"},"[]"]},{"id":"def-common.Datatable.rows","type":"Array","label":"rows","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L101"},"signature":["Record[]"]}],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L98"},"initialIsOpen":false},{"id":"def-common.SerializedDatatable","type":"Interface","label":"SerializedDatatable","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializedDatatable","text":"SerializedDatatable"}," extends ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"}],"description":[],"children":[{"id":"def-common.SerializedDatatable.rows","type":"Array","label":"rows","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":105,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L105"},"signature":["string[][]"]}],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L104"},"initialIsOpen":false},{"id":"def-common.ExpressionImage","type":"Interface","label":"ExpressionImage","description":[],"children":[{"id":"def-common.ExpressionImage.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/image.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L15"},"signature":["\"image\""]},{"id":"def-common.ExpressionImage.mode","type":"string","label":"mode","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/image.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L16"}},{"id":"def-common.ExpressionImage.dataurl","type":"string","label":"dataurl","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/image.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L17"}}],"source":{"path":"src/plugins/expressions/common/expression_types/specs/image.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L14"},"initialIsOpen":false},{"id":"def-common.PointSeriesColumn","type":"Interface","label":"PointSeriesColumn","description":["\nColumn in a PointSeries"],"children":[{"id":"def-common.PointSeriesColumn.type","type":"CompoundType","label":"type","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L24"},"signature":["\"string\" | \"number\""]},{"id":"def-common.PointSeriesColumn.role","type":"CompoundType","label":"role","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L25"},"signature":["\"measure\" | \"dimension\""]},{"id":"def-common.PointSeriesColumn.expression","type":"string","label":"expression","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L26"}}],"source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L23"},"initialIsOpen":false},{"id":"def-common.Range","type":"Interface","label":"Range","description":[],"children":[{"id":"def-common.Range.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/range.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L15"},"signature":["\"range\""]},{"id":"def-common.Range.from","type":"number","label":"from","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/range.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L16"}},{"id":"def-common.Range.to","type":"number","label":"to","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/range.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L17"}},{"id":"def-common.Range.label","type":"string","label":"label","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/range.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L18"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/expressions/common/expression_types/specs/range.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L14"},"initialIsOpen":false},{"id":"def-common.ExpressionFunctionDefinition","type":"Interface","label":"ExpressionFunctionDefinition","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunctionDefinition","text":"ExpressionFunctionDefinition"}," extends Partial<",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.PersistableState","text":"PersistableState"},">>"],"description":["\n`ExpressionFunctionDefinition` is the interface plugins have to implement to\nregister a function in `expressions` plugin."],"children":[{"id":"def-common.ExpressionFunctionDefinition.name","type":"Uncategorized","label":"name","description":["\nThe name of the function, as will be used in expression."],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L40"},"signature":["Name"]},{"id":"def-common.ExpressionFunctionDefinition.disabled","type":"CompoundType","label":"disabled","description":["\nif set to true function will be disabled (but its migrate function will still be available)"],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L45"},"signature":["boolean | undefined"]},{"id":"def-common.ExpressionFunctionDefinition.type","type":"CompoundType","label":"type","description":["\nName of type of value this function outputs."],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L50"},"signature":["\"date\" | \"filter\" | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.KnownTypeToString","text":"KnownTypeToString"},"<","UnwrapPromiseOrReturn","> | undefined"]},{"id":"def-common.ExpressionFunctionDefinition.inputTypes","type":"Array","label":"inputTypes","description":["\nList of allowed type names for input value of this function. If this\nproperty is set the input of function will be cast to the first possible\ntype in this list. If this property is missing the input will be provided\nto the function as-is."],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L58"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.TypeToString","text":"TypeToString"},"[] | undefined"]},{"id":"def-common.ExpressionFunctionDefinition.args","type":"Object","label":"args","description":["\nSpecification of arguments that function supports. This list will also be\nused for autocomplete functionality when your function is being edited."],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L64"},"signature":["{ [key in keyof Arguments]: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ArgumentType","text":"ArgumentType"},"; }"]},{"id":"def-common.ExpressionFunctionDefinition.aliases","type":"Array","label":"aliases","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L69"},"signature":["string[] | undefined"]},{"id":"def-common.ExpressionFunctionDefinition.help","type":"string","label":"help","description":["\nHelp text displayed in the Expression editor. This text should be\ninternationalized."],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L75"}},{"id":"def-common.ExpressionFunctionDefinition.fn","type":"Function","label":"fn","signature":["(input: Input, args: Arguments, context: Context) => Output"],"description":["\nThe actual implementation of the function.\n"],"children":[{"type":"Uncategorized","label":"input","isRequired":true,"signature":["Input"],"description":["Output of the previous function, or initial input."],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L86"}},{"type":"Uncategorized","label":"args","isRequired":true,"signature":["Arguments"],"description":["Parameters set for this function in expression."],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L86"}},{"type":"Uncategorized","label":"context","isRequired":true,"signature":["Context"],"description":["Object with functions to perform side effects. This object\nis created for the duration of the execution of expression and is the\nsame for all functions in expression chain."],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L86"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L86"}},{"id":"def-common.ExpressionFunctionDefinition.context","type":"Object","label":"context","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":91,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L91"},"signature":["{ types: any[] | undefined; } | undefined"]}],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L30"},"initialIsOpen":false},{"id":"def-common.ExpressionFunctionDefinitions","type":"Interface","label":"ExpressionFunctionDefinitions","description":["\nA mapping of `ExpressionFunctionDefinition`s for functions which the\nExpressions services provides out-of-the-box. Any new functions registered\nby the Expressions plugin should have their types added here.\n"],"children":[{"id":"def-common.ExpressionFunctionDefinitions.clog","type":"Object","label":"clog","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":117,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L117"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunctionClog","text":"ExpressionFunctionClog"}]},{"id":"def-common.ExpressionFunctionDefinitions.font","type":"Object","label":"font","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":118,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L118"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunctionFont","text":"ExpressionFunctionFont"}]},{"id":"def-common.ExpressionFunctionDefinitions.var_set","type":"Object","label":"var_set","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":119,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L119"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunctionVarSet","text":"ExpressionFunctionVarSet"}]},{"id":"def-common.ExpressionFunctionDefinitions.var","type":"Object","label":"var","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":120,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L120"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunctionVar","text":"ExpressionFunctionVar"}]},{"id":"def-common.ExpressionFunctionDefinitions.theme","type":"Object","label":"theme","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":121,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L121"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunctionTheme","text":"ExpressionFunctionTheme"}]},{"id":"def-common.ExpressionFunctionDefinitions.cumulative_sum","type":"Object","label":"cumulative_sum","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":122,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L122"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunctionCumulativeSum","text":"ExpressionFunctionCumulativeSum"}]},{"id":"def-common.ExpressionFunctionDefinitions.derivative","type":"Object","label":"derivative","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":123,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L123"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunctionDerivative","text":"ExpressionFunctionDerivative"}]},{"id":"def-common.ExpressionFunctionDefinitions.moving_average","type":"Object","label":"moving_average","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":124,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L124"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunctionMovingAverage","text":"ExpressionFunctionMovingAverage"}]}],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L116"},"initialIsOpen":false},{"id":"def-common.MapColumnArguments","type":"Interface","label":"MapColumnArguments","description":[],"children":[{"id":"def-common.MapColumnArguments.id","type":"CompoundType","label":"id","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L14"},"signature":["string | null | undefined"]},{"id":"def-common.MapColumnArguments.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L15"}},{"id":"def-common.MapColumnArguments.expression","type":"Function","label":"expression","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L16"},"signature":["((datatable: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"},") => Promise) | undefined"]},{"id":"def-common.MapColumnArguments.copyMetaFrom","type":"CompoundType","label":"copyMetaFrom","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L17"},"signature":["string | null | undefined"]}],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L13"},"initialIsOpen":false},{"id":"def-common.CumulativeSumArgs","type":"Interface","label":"CumulativeSumArgs","description":[],"children":[{"id":"def-common.CumulativeSumArgs.by","type":"Array","label":"by","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L15"},"signature":["string[] | undefined"]},{"id":"def-common.CumulativeSumArgs.inputColumnId","type":"string","label":"inputColumnId","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L16"}},{"id":"def-common.CumulativeSumArgs.outputColumnId","type":"string","label":"outputColumnId","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L17"}},{"id":"def-common.CumulativeSumArgs.outputColumnName","type":"string","label":"outputColumnName","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L18"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L14"},"initialIsOpen":false},{"id":"def-common.DerivativeArgs","type":"Interface","label":"DerivativeArgs","description":[],"children":[{"id":"def-common.DerivativeArgs.by","type":"Array","label":"by","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L15"},"signature":["string[] | undefined"]},{"id":"def-common.DerivativeArgs.inputColumnId","type":"string","label":"inputColumnId","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L16"}},{"id":"def-common.DerivativeArgs.outputColumnId","type":"string","label":"outputColumnId","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L17"}},{"id":"def-common.DerivativeArgs.outputColumnName","type":"string","label":"outputColumnName","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L18"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L14"},"initialIsOpen":false},{"id":"def-common.MovingAverageArgs","type":"Interface","label":"MovingAverageArgs","description":[],"children":[{"id":"def-common.MovingAverageArgs.by","type":"Array","label":"by","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L15"},"signature":["string[] | undefined"]},{"id":"def-common.MovingAverageArgs.inputColumnId","type":"string","label":"inputColumnId","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L16"}},{"id":"def-common.MovingAverageArgs.outputColumnId","type":"string","label":"outputColumnId","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L17"}},{"id":"def-common.MovingAverageArgs.outputColumnName","type":"string","label":"outputColumnName","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L18"},"signature":["string | undefined"]},{"id":"def-common.MovingAverageArgs.window","type":"number","label":"window","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L19"}}],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L14"},"initialIsOpen":false},{"id":"def-common.ExpressionRenderDefinition","type":"Interface","label":"ExpressionRenderDefinition","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRenderDefinition","text":"ExpressionRenderDefinition"},""],"description":[],"children":[{"id":"def-common.ExpressionRenderDefinition.name","type":"string","label":"name","description":["\nTechnical name of the renderer, used as ID to identify renderer in\nexpression renderer registry. This must match the name of the expression\nfunction that is used to create the `type: render` object."],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L15"}},{"id":"def-common.ExpressionRenderDefinition.displayName","type":"string","label":"displayName","description":["\nA user friendly name of the renderer as will be displayed to user in UI."],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L20"},"signature":["string | undefined"]},{"id":"def-common.ExpressionRenderDefinition.help","type":"string","label":"help","description":["\nHelp text as will be displayed to user. A sentence or few about what this\nelement does."],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L26"},"signature":["string | undefined"]},{"id":"def-common.ExpressionRenderDefinition.validate","type":"Function","label":"validate","description":["\nUsed to validate the data before calling the render function."],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L31"},"signature":["(() => Error | undefined) | undefined"]},{"id":"def-common.ExpressionRenderDefinition.reuseDomNode","type":"boolean","label":"reuseDomNode","description":["\nTell the renderer if the dom node should be reused, it's recreated each\ntime by default."],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L37"}},{"id":"def-common.ExpressionRenderDefinition.render","type":"Function","label":"render","description":["\nThe function called to render the output data of an expression."],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L42"},"signature":["(domNode: HTMLElement, config: Config, handlers: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.IInterpreterRenderHandlers","text":"IInterpreterRenderHandlers"},") => void | Promise"]}],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L9"},"initialIsOpen":false},{"id":"def-common.IInterpreterRenderHandlers","type":"Interface","label":"IInterpreterRenderHandlers","description":[],"children":[{"id":"def-common.IInterpreterRenderHandlers.done","type":"Function","label":"done","description":["\nDone increments the number of rendering successes"],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L67"},"signature":["() => void"]},{"id":"def-common.IInterpreterRenderHandlers.onDestroy","type":"Function","label":"onDestroy","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L68"},"signature":["(fn: () => void) => void"]},{"id":"def-common.IInterpreterRenderHandlers.reload","type":"Function","label":"reload","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L69"},"signature":["() => void"]},{"id":"def-common.IInterpreterRenderHandlers.update","type":"Function","label":"update","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L70"},"signature":["(params: any) => void"]},{"id":"def-common.IInterpreterRenderHandlers.event","type":"Function","label":"event","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L71"},"signature":["(event: any) => void"]},{"id":"def-common.IInterpreterRenderHandlers.hasCompatibleActions","type":"Function","label":"hasCompatibleActions","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L72"},"signature":["((event: any) => Promise) | undefined"]},{"id":"def-common.IInterpreterRenderHandlers.getRenderMode","type":"Function","label":"getRenderMode","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L73"},"signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.RenderMode","text":"RenderMode"}]},{"id":"def-common.IInterpreterRenderHandlers.isSyncColorsEnabled","type":"Function","label":"isSyncColorsEnabled","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L74"},"signature":["() => boolean"]},{"id":"def-common.IInterpreterRenderHandlers.uiState","type":"Unknown","label":"uiState","description":["\nThis uiState interface is actually `PersistedState` from the visualizations plugin,\nbut expressions cannot know about vis or it creates a mess of circular dependencies.\nDownstream consumers of the uiState handler will need to cast for now."],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L80"},"signature":["unknown"]}],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L63"},"initialIsOpen":false},{"id":"def-common.ExecutorState","type":"Interface","label":"ExecutorState","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"},""],"description":[],"children":[{"id":"def-common.ExecutorState.functions","type":"Object","label":"functions","description":[],"source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L17"},"signature":["Record"]},{"id":"def-common.ExecutorState.types","type":"Object","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L18"},"signature":["Record"]},{"id":"def-common.ExecutorState.context","type":"Uncategorized","label":"context","description":[],"source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L19"},"signature":["Context"]}],"source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L16"},"initialIsOpen":false},{"id":"def-common.ExecutorPureTransitions","type":"Interface","label":"ExecutorPureTransitions","description":[],"children":[{"id":"def-common.ExecutorPureTransitions.addFunction","type":"Function","label":"addFunction","description":[],"source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L29"},"signature":["(state: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"},">) => (fn: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"},") => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"},">"]},{"id":"def-common.ExecutorPureTransitions.addType","type":"Function","label":"addType","description":[],"source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L30"},"signature":["(state: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"},">) => (type: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionType","text":"ExpressionType"},") => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"},">"]},{"id":"def-common.ExecutorPureTransitions.extendContext","type":"Function","label":"extendContext","description":[],"source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L31"},"signature":["(state: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"},">) => (extraContext: Record) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"},">"]}],"source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L28"},"initialIsOpen":false},{"id":"def-common.ExecutorPureSelectors","type":"Interface","label":"ExecutorPureSelectors","description":[],"children":[{"id":"def-common.ExecutorPureSelectors.getFunction","type":"Function","label":"getFunction","description":[],"source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L44"},"signature":["(state: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"},">) => (id: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"}," | null"]},{"id":"def-common.ExecutorPureSelectors.getType","type":"Function","label":"getType","description":[],"source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L45"},"signature":["(state: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"},">) => (id: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionType","text":"ExpressionType"}," | null"]},{"id":"def-common.ExecutorPureSelectors.getContext","type":"Function","label":"getContext","description":[],"source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L46"},"signature":["(state: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"},">) => () => Record"]}],"source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L43"},"initialIsOpen":false},{"id":"def-common.ExpressionExecOptions","type":"Interface","label":"ExpressionExecOptions","description":[],"children":[{"id":"def-common.ExpressionExecOptions.debug","type":"CompoundType","label":"debug","description":["\nWhether to execute expression in *debug mode*. In *debug mode* inputs and\noutputs as well as all resolved arguments and time it took to execute each\nfunction are saved and are available for introspection."],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L33"},"signature":["boolean | undefined"]}],"source":{"path":"src/plugins/expressions/common/executor/executor.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/executor.ts#L27"},"initialIsOpen":false},{"id":"def-common.ExecutionContext","type":"Interface","label":"ExecutionContext","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},""],"description":["\n`ExecutionContext` is an object available to all functions during a single execution;\nit provides various methods to perform side-effects."],"children":[{"id":"def-common.ExecutionContext.getSearchContext","type":"Function","label":"getSearchContext","description":["\nGet search context of the expression."],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L28"},"signature":["() => ExecutionContextSearch"]},{"id":"def-common.ExecutionContext.variables","type":"Object","label":"variables","description":["\nContext variables that can be consumed using `var` and `var_set` functions."],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L33"},"signature":["Record"]},{"id":"def-common.ExecutionContext.types","type":"Object","label":"types","description":["\nA map of available expression types."],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L38"},"signature":["Record"]},{"id":"def-common.ExecutionContext.abortSignal","type":"Object","label":"abortSignal","description":["\nAdds ability to abort current execution."],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L43"},"signature":["AbortSignal"]},{"id":"def-common.ExecutionContext.inspectorAdapters","type":"Uncategorized","label":"inspectorAdapters","description":["\nAdapters for `inspector` plugin."],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L48"},"signature":["InspectorAdapters"]},{"id":"def-common.ExecutionContext.getSearchSessionId","type":"Function","label":"getSearchSessionId","description":["\nSearch context in which expression should operate."],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L53"},"signature":["() => string | undefined"]},{"id":"def-common.ExecutionContext.getKibanaRequest","type":"Function","label":"getKibanaRequest","description":["\nGetter to retrieve the `KibanaRequest` object inside an expression function.\nUseful for functions which are running on the server and need to perform\noperations that are scoped to a specific user."],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L60"},"signature":["(() => ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},") | undefined"]},{"id":"def-common.ExecutionContext.getSavedObject","type":"Function","label":"getSavedObject","description":["\nAllows to fetch saved objects from ElasticSearch. In browser `getSavedObject`\nfunction is provided automatically by the Expressions plugin. On the server\nthe caller of the expression has to provide this context function. The\nreason is because on the browser we always know the user who tries to\nfetch a saved object, thus saved object client is scoped automatically to\nthat user. However, on the server we can scope that saved object client to\nany user, or even not scope it at all and execute it as an \"internal\" user."],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L71"},"signature":["((type: string, id: string) => Promise<",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},">) | undefined"]},{"id":"def-common.ExecutionContext.isSyncColorsEnabled","type":"Function","label":"isSyncColorsEnabled","description":["\nReturns the state (true|false) of the sync colors across panels switch."],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L79"},"signature":["(() => boolean) | undefined"]}],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L21"},"initialIsOpen":false},{"id":"def-common.DefaultInspectorAdapters","type":"Interface","label":"DefaultInspectorAdapters","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.DefaultInspectorAdapters","text":"DefaultInspectorAdapters"}," extends ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"}],"description":["\nDefault inspector adapters created if inspector adapters are not set explicitly."],"children":[{"id":"def-common.DefaultInspectorAdapters.requests","type":"Object","label":"requests","description":[],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L86"},"signature":[{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.RequestAdapter","text":"RequestAdapter"}]},{"id":"def-common.DefaultInspectorAdapters.tables","type":"Object","label":"tables","description":[],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":87,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L87"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.TablesAdapter","text":"TablesAdapter"}]}],"source":{"path":"src/plugins/expressions/common/execution/types.ts","lineNumber":85,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/types.ts#L85"},"initialIsOpen":false},{"id":"def-common.ExecutionState","type":"Interface","label":"ExecutionState","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionState","text":"ExecutionState"}," extends ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"},">"],"description":[],"children":[{"id":"def-common.ExecutionState.ast","type":"Object","label":"ast","description":[],"source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L18"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}]},{"id":"def-common.ExecutionState.state","type":"CompoundType","label":"state","description":["\nTracks state of execution.\n\n- `not-started` - before .start() method was called.\n- `pending` - immediately after .start() method is called.\n- `result` - when expression execution completed.\n- `error` - when execution failed with error."],"source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L28"},"signature":["\"result\" | \"error\" | \"not-started\" | \"pending\""]},{"id":"def-common.ExecutionState.result","type":"Uncategorized","label":"result","description":["\nResult of the expression execution."],"source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L33"},"signature":["Output | undefined"]},{"id":"def-common.ExecutionState.error","type":"Object","label":"error","description":["\nError happened during the execution."],"source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L38"},"signature":["Error | undefined"]}],"source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L17"},"initialIsOpen":false},{"id":"def-common.ExecutionPureTransitions","type":"Interface","label":"ExecutionPureTransitions","signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionPureTransitions","text":"ExecutionPureTransitions"},""],"description":[],"children":[{"id":"def-common.ExecutionPureTransitions.start","type":"Function","label":"start","description":[],"source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L51"},"signature":["(state: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionState","text":"ExecutionState"},") => () => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionState","text":"ExecutionState"},""]},{"id":"def-common.ExecutionPureTransitions.setResult","type":"Function","label":"setResult","description":[],"source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L52"},"signature":["(state: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionState","text":"ExecutionState"},") => (result: Output) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionState","text":"ExecutionState"},""]},{"id":"def-common.ExecutionPureTransitions.setError","type":"Function","label":"setError","description":[],"source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L53"},"signature":["(state: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionState","text":"ExecutionState"},") => (error: Error) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionState","text":"ExecutionState"},""]}],"source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L50"},"initialIsOpen":false},{"id":"def-common.ExecutionParams","type":"Interface","label":"ExecutionParams","description":[],"children":[{"id":"def-common.ExecutionParams.executor","type":"Object","label":"executor","description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L58"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Executor","text":"Executor"},""]},{"id":"def-common.ExecutionParams.ast","type":"Object","label":"ast","description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L59"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}," | undefined"]},{"id":"def-common.ExecutionParams.expression","type":"string","label":"expression","description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L60"},"signature":["string | undefined"]},{"id":"def-common.ExecutionParams.params","type":"Object","label":"params","description":[],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L61"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionExecutionParams","text":"ExpressionExecutionParams"}]}],"source":{"path":"src/plugins/expressions/common/execution/execution.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/execution.ts#L57"},"initialIsOpen":false},{"id":"def-common.ExpressionExecutionParams","type":"Interface","label":"ExpressionExecutionParams","description":[],"children":[{"id":"def-common.ExpressionExecutionParams.searchContext","type":"Object","label":"searchContext","description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L42"},"signature":[{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined"]},{"id":"def-common.ExpressionExecutionParams.variables","type":"Object","label":"variables","description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L44"},"signature":["Record | undefined"]},{"id":"def-common.ExpressionExecutionParams.debug","type":"CompoundType","label":"debug","description":["\nWhether to execute expression in *debug mode*. In *debug mode* inputs and\noutputs as well as all resolved arguments and time it took to execute each\nfunction are saved and are available for introspection."],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L51"},"signature":["boolean | undefined"]},{"id":"def-common.ExpressionExecutionParams.kibanaRequest","type":"Object","label":"kibanaRequest","description":["\nMakes a `KibanaRequest` object available to expression functions. Useful for\nfunctions which are running on the server and need to perform operations that\nare scoped to a specific user."],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L58"},"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"}," | undefined"]},{"id":"def-common.ExpressionExecutionParams.searchSessionId","type":"string","label":"searchSessionId","description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L60"},"signature":["string | undefined"]},{"id":"def-common.ExpressionExecutionParams.syncColors","type":"CompoundType","label":"syncColors","description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L62"},"signature":["boolean | undefined"]},{"id":"def-common.ExpressionExecutionParams.inspectorAdapters","type":"Object","label":"inspectorAdapters","description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L64"},"signature":[{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"}," | undefined"]}],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L41"},"initialIsOpen":false},{"id":"def-common.ExpressionsServiceStart","type":"Interface","label":"ExpressionsServiceStart","description":["\nThe public contract that `ExpressionsService` provides to other plugins\nin Kibana Platform in *start* life-cycle."],"children":[{"id":"def-common.ExpressionsServiceStart.getFunction","type":"Function","label":"getFunction","description":["\nGet a registered `ExpressionFunction` by its name, which was registered\nusing the `registerFunction` method. The returned `ExpressionFunction`\ninstance is an internal representation of the function in Expressions\nservice - do not mutate that object."],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L78"},"signature":["(name: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"}," | undefined"]},{"id":"def-common.ExpressionsServiceStart.getRenderer","type":"Function","label":"getRenderer","description":["\nGet a registered `ExpressionRenderer` by its name, which was registered\nusing the `registerRenderer` method. The returned `ExpressionRenderer`\ninstance is an internal representation of the renderer in Expressions\nservice - do not mutate that object."],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L86"},"signature":["(name: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRenderer","text":"ExpressionRenderer"}," | null"]},{"id":"def-common.ExpressionsServiceStart.getType","type":"Function","label":"getType","description":["\nGet a registered `ExpressionType` by its name, which was registered\nusing the `registerType` method. The returned `ExpressionType`\ninstance is an internal representation of the type in Expressions\nservice - do not mutate that object."],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L94"},"signature":["(name: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionType","text":"ExpressionType"}," | undefined"]},{"id":"def-common.ExpressionsServiceStart.run","type":"Function","label":"run","description":["\nExecutes expression string or a parsed expression AST and immediately\nreturns the result.\n\nBelow example will execute `sleep 100 | clog` expression with `123` initial\ninput to the first function.\n\n```ts\nexpressions.run('sleep 100 | clog', 123);\n```\n\n- `sleep 100` will delay execution by 100 milliseconds and pass the `123` input as\n its output.\n- `clog` will print to console `123` and pass it as its output.\n- The final result of the execution will be `123`.\n\nOptionally, you can pass an object as the third argument which will be used\nto extend the `ExecutionContext`—an object passed to each function\nas the third argument, that allows functions to perform side-effects.\n\n```ts\nexpressions.run('...', null, { elasticsearchClient });\n```"],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":120,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L120"},"signature":["(ast: string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},", input: Input, params?: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionExecutionParams","text":"ExpressionExecutionParams"}," | undefined) => Promise"]},{"id":"def-common.ExpressionsServiceStart.execute","type":"Function","label":"execute","description":["\nStarts expression execution and immediately returns `ExecutionContract`\ninstance that tracks the progress of the execution and can be used to\ninteract with the execution."],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L131"},"signature":["(ast: string | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},", input: Input, params?: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionExecutionParams","text":"ExpressionExecutionParams"}," | undefined) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContract","text":"ExecutionContract"},""]},{"id":"def-common.ExpressionsServiceStart.fork","type":"Function","label":"fork","description":["\nCreate a new instance of `ExpressionsService`. The new instance inherits\nall state of the original `ExpressionsService`, including all expression\ntypes, expression functions and context. Also, all new types and functions\nregistered in the original services AFTER the forking event will be\navailable in the forked instance. However, all new types and functions\nregistered in the forked instances will NOT be available to the original\nservice."],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":147,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L147"},"signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionsService","text":"ExpressionsService"}]}],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L71"},"initialIsOpen":false},{"id":"def-common.ExpressionServiceParams","type":"Interface","label":"ExpressionServiceParams","description":[],"children":[{"id":"def-common.ExpressionServiceParams.executor","type":"Object","label":"executor","description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":151,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L151"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Executor","text":"Executor"},"> | undefined"]},{"id":"def-common.ExpressionServiceParams.renderers","type":"Object","label":"renderers","description":[],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":152,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L152"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRendererRegistry","text":"ExpressionRendererRegistry"}," | undefined"]}],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":150,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L150"},"initialIsOpen":false}],"enums":[{"id":"def-common.BackgroundRepeat","type":"Enum","label":"BackgroundRepeat","description":["\nEnum of supported CSS `background-repeat` properties."],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L14"},"initialIsOpen":false},{"id":"def-common.BackgroundSize","type":"Enum","label":"BackgroundSize","description":["\nEnum of supported CSS `background-size` properties."],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L26"},"initialIsOpen":false},{"id":"def-common.FontStyle","type":"Enum","label":"FontStyle","description":["\nEnum of supported CSS `font-style` properties."],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L35"},"initialIsOpen":false},{"id":"def-common.FontWeight","type":"Enum","label":"FontWeight","description":["\nEnum of supported CSS `font-weight` properties."],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L43"},"initialIsOpen":false},{"id":"def-common.Overflow","type":"Enum","label":"Overflow","description":["\nEnum of supported CSS `overflow` properties."],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L62"},"initialIsOpen":false},{"id":"def-common.TextAlignment","type":"Enum","label":"TextAlignment","description":["\nEnum of supported CSS `text-align` properties."],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L72"},"initialIsOpen":false},{"id":"def-common.TextDecoration","type":"Enum","label":"TextDecoration","description":["\nEnum of supported CSS `text-decoration` properties."],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L82"},"initialIsOpen":false}],"misc":[{"id":"def-common.TypeToString","type":"Type","label":"TypeToString","description":["\nThis can convert a type into a known Expression string representation of\nthat type. For example, `TypeToString` will resolve to `'datatable'`.\nThis allows Expression Functions to continue to specify their type in a\nsimple string format."],"source":{"path":"src/plugins/expressions/common/types/common.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L17"},"signature":["\"date\" | \"filter\" | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.KnownTypeToString","text":"KnownTypeToString"},""],"initialIsOpen":false},{"id":"def-common.KnownTypeToString","type":"Type","label":"KnownTypeToString","description":["\nMap the type of the generic to a string-based representation of the type.\n\nIf the provided generic is its own type interface, we use the value of\nthe `type` key as a string literal type for it."],"source":{"path":"src/plugins/expressions/common/types/common.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L26"},"signature":["T extends string ? \"string\" : T extends boolean ? \"boolean\" : T extends number ? \"number\" : T extends null ? \"null\" : T extends { type: string; } ? T[\"type\"] : never"],"initialIsOpen":false},{"id":"def-common.TypeString","type":"Type","label":"TypeString","description":["\nIf the type extends a Promise, we still need to return the string representation:\n\n`someArgument: Promise` results in `types: ['boolean', 'string']`"],"source":{"path":"src/plugins/expressions/common/types/common.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L39"},"signature":["UnwrapPromiseOrReturn extends string ? \"string\" : UnwrapPromiseOrReturn extends boolean ? \"boolean\" : UnwrapPromiseOrReturn extends number ? \"number\" : UnwrapPromiseOrReturn extends null ? \"null\" : UnwrapPromiseOrReturn extends { type: string; } ? ({ type: string; } & UnwrapPromiseOrReturn)[\"type\"] : never"],"initialIsOpen":false},{"id":"def-common.UnmappedTypeStrings","type":"Type","label":"UnmappedTypeStrings","description":["\nTypes used in Expressions that don't map to a primitive cleanly:\n\n`date` is typed as a number or string, and represents a date"],"source":{"path":"src/plugins/expressions/common/types/common.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/common.ts#L46"},"signature":["\"date\" | \"filter\""],"initialIsOpen":false},{"id":"def-common.Style","type":"Type","label":"Style","description":[],"source":{"path":"src/plugins/expressions/common/types/style.ts","lineNumber":126,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/types/style.ts#L126"},"signature":["ExpressionTypeStyle"],"initialIsOpen":false},{"id":"def-common.InferFunctionDefinition","type":"Type","label":"InferFunctionDefinition","description":[],"source":{"path":"src/plugins/expressions/common/ast/build_function.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/build_function.ts#L24"},"signature":["FnDef extends ExpressionFunctionDefinition ? { name: Name; input: Input; arguments: Arguments; output: Output; context: Context; } : never"],"initialIsOpen":false},{"id":"def-common.ExpressionAstNode","type":"Type","label":"ExpressionAstNode","description":[],"source":{"path":"src/plugins/expressions/common/ast/types.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/types.ts#L11"},"signature":["string | number | false | true | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstFunction","text":"ExpressionAstFunction"}," | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"initialIsOpen":false},{"id":"def-common.ExpressionAstExpression","type":"Type","label":"ExpressionAstExpression","description":[],"source":{"path":"src/plugins/expressions/common/ast/types.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/types.ts#L16"},"signature":["{ type: 'expression'; chain: ExpressionAstFunction[]; }"],"initialIsOpen":false},{"id":"def-common.ExpressionAstFunction","type":"Type","label":"ExpressionAstFunction","description":[],"source":{"path":"src/plugins/expressions/common/ast/types.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/types.ts#L21"},"signature":["{ type: 'function'; function: string; arguments: Record; debug?: ExpressionAstFunctionDebug | undefined; }"],"initialIsOpen":false},{"id":"def-common.ExpressionAstFunctionDebug","type":"Type","label":"ExpressionAstFunctionDebug","description":[],"source":{"path":"src/plugins/expressions/common/ast/types.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/types.ts#L32"},"signature":["{ success: boolean; fn: string; input: ExpressionValue; args: Record; output?: ExpressionValue; error?: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"error\", { error: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ErrorLike","text":"ErrorLike"},"; info?: ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined; }> | undefined; rawError?: any | Error; duration: number | undefined; }"],"initialIsOpen":false},{"id":"def-common.ExpressionAstArgument","type":"Type","label":"ExpressionAstArgument","description":[],"source":{"path":"src/plugins/expressions/common/ast/types.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/ast/types.ts#L77"},"signature":["string | number | false | true | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"}],"initialIsOpen":false},{"id":"def-common.FontLabel","type":"Type","label":"FontLabel","description":["\nThis type contains a unions of all supported font labels, or the the name of\nthe font the user would see in a UI."],"source":{"path":"src/plugins/expressions/common/fonts.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L13"},"signature":["\"American Typewriter\" | \"Arial\" | \"Baskerville\" | \"Book Antiqua\" | \"Brush Script\" | \"Chalkboard\" | \"Didot\" | \"Futura\" | \"Gill Sans\" | \"Helvetica Neue\" | \"Hoefler Text\" | \"Lucida Grande\" | \"Myriad\" | \"Open Sans\" | \"Optima\" | \"Palatino\""],"initialIsOpen":false},{"id":"def-common.FontValue","type":"Type","label":"FontValue","description":["\nThis type contains a union of all supported font values, equivalent to the CSS\n`font-value` property."],"source":{"path":"src/plugins/expressions/common/fonts.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L19"},"signature":["\"'American Typewriter', 'Courier New', Courier, Monaco, mono\" | \"Arial, sans-serif\" | \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\" | \"'Brush Script MT', 'Comic Sans', sans-serif\" | \"Chalkboard, 'Comic Sans', sans-serif\" | \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\" | \"Futura, Impact, Helvetica, Arial, sans-serif\" | \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"'Helvetica Neue', Helvetica, Arial, sans-serif\" | \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\" | \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\" | \"Myriad, Helvetica, Arial, sans-serif\" | \"'Open Sans', Helvetica, Arial, sans-serif\" | \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\" | \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\""],"initialIsOpen":false},{"id":"def-common.fonts","type":"Array","label":"fonts","description":["\nA collection of supported fonts."],"source":{"path":"src/plugins/expressions/common/fonts.ts","lineNumber":123,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/fonts.ts#L123"},"signature":["({ label: \"American Typewriter\"; value: \"'American Typewriter', 'Courier New', Courier, Monaco, mono\"; } | { label: \"Arial\"; value: \"Arial, sans-serif\"; } | { label: \"Baskerville\"; value: \"Baskerville, Georgia, Garamond, 'Times New Roman', Times, serif\"; } | { label: \"Book Antiqua\"; value: \"'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"; } | { label: \"Brush Script\"; value: \"'Brush Script MT', 'Comic Sans', sans-serif\"; } | { label: \"Chalkboard\"; value: \"Chalkboard, 'Comic Sans', sans-serif\"; } | { label: \"Didot\"; value: \"Didot, Georgia, Garamond, 'Times New Roman', Times, serif\"; } | { label: \"Futura\"; value: \"Futura, Impact, Helvetica, Arial, sans-serif\"; } | { label: \"Gill Sans\"; value: \"'Gill Sans', 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\"; } | { label: \"Helvetica Neue\"; value: \"'Helvetica Neue', Helvetica, Arial, sans-serif\"; } | { label: \"Hoefler Text\"; value: \"'Hoefler Text', Garamond, Georgia, 'Times New Roman', Times, serif\"; } | { label: \"Lucida Grande\"; value: \"'Lucida Grande', 'Lucida Sans Unicode', Lucida, Verdana, Helvetica, Arial, sans-serif\"; } | { label: \"Myriad\"; value: \"Myriad, Helvetica, Arial, sans-serif\"; } | { label: \"Open Sans\"; value: \"'Open Sans', Helvetica, Arial, sans-serif\"; } | { label: \"Optima\"; value: \"Optima, 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Helvetica, Arial, sans-serif\"; } | { label: \"Palatino\"; value: \"Palatino, 'Book Antiqua', Georgia, Garamond, 'Times New Roman', Times, serif\"; })[]"],"initialIsOpen":false},{"id":"def-common.ExpressionValueUnboxed","type":"Type","label":"ExpressionValueUnboxed","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L9"},"signature":["any"],"initialIsOpen":false},{"id":"def-common.ExpressionValueBoxed","type":"Type","label":"ExpressionValueBoxed","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L11"},"signature":["{ type: Type; } & Value"],"initialIsOpen":false},{"id":"def-common.ExpressionValue","type":"Type","label":"ExpressionValue","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L15"},"signature":["any"],"initialIsOpen":false},{"id":"def-common.ExpressionValueConverter","type":"Type","label":"ExpressionValueConverter","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L17"},"signature":["(input: I, availableTypes: Record) => O"],"initialIsOpen":false},{"id":"def-common.AnyExpressionTypeDefinition","type":"Type","label":"AnyExpressionTypeDefinition","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/types.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/types.ts#L46"},"signature":["ExpressionTypeDefinition"],"initialIsOpen":false},{"id":"def-common.typeSpecs","type":"Array","label":"typeSpecs","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/index.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/index.ts#L25"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionTypeDefinition","text":"AnyExpressionTypeDefinition"},"[]"],"initialIsOpen":false},{"id":"def-common.DatatableColumnType","type":"Type","label":"DatatableColumnType","description":["\nThis type represents the `type` of any `DatatableColumn` in a `Datatable`.\nits duplicated from KBN_FIELD_TYPES"],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L36"},"signature":["\"string\" | \"number\" | \"boolean\" | \"object\" | \"date\" | \"ip\" | \"_source\" | \"attachment\" | \"geo_point\" | \"geo_shape\" | \"murmur3\" | \"unknown\" | \"conflict\" | \"nested\" | \"histogram\" | \"null\""],"initialIsOpen":false},{"id":"def-common.DatatableRow","type":"Type","label":"DatatableRow","description":["\nThis type represents a row in a `Datatable`."],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L57"},"signature":["{ [x: string]: any; }"],"initialIsOpen":false},{"id":"def-common.ExpressionValueError","type":"Type","label":"ExpressionValueError","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/error.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/error.ts#L17"},"signature":["{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }"],"initialIsOpen":false},{"id":"def-common.InterpreterErrorType","type":"Type","label":"InterpreterErrorType","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/error.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/error.ts#L33"},"signature":["{ type: \"error\"; } & { error: ErrorLike; info?: SerializableState | undefined; }"],"initialIsOpen":false},{"id":"def-common.ExpressionValueFilter","type":"Type","label":"ExpressionValueFilter","description":["\nRepresents an object that is a Filter."],"source":{"path":"src/plugins/expressions/common/expression_types/specs/filter.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/filter.ts#L14"},"signature":["{ type: \"filter\"; } & { filterType?: string | undefined; value?: string | undefined; column?: string | undefined; and: ExpressionValueFilter[]; to?: string | undefined; from?: string | undefined; query?: string | null | undefined; }"],"initialIsOpen":false},{"id":"def-common.ExpressionValueNum","type":"Type","label":"ExpressionValueNum","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/num.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L14"},"signature":["{ type: \"num\"; } & { value: number; }"],"initialIsOpen":false},{"id":"def-common.PointSeriesColumnName","type":"Type","label":"PointSeriesColumnName","description":["\nAllowed column names in a PointSeries"],"source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L18"},"signature":["\"color\" | \"y\" | \"x\" | \"text\" | \"size\""],"initialIsOpen":false},{"id":"def-common.PointSeriesColumns","type":"Type","label":"PointSeriesColumns","description":["\nRepresents a collection of valid Columns in a PointSeries"],"source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L32"},"signature":["{} | Record<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.PointSeriesColumnName","text":"PointSeriesColumnName"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.PointSeriesColumn","text":"PointSeriesColumn"},">"],"initialIsOpen":false},{"id":"def-common.PointSeriesRow","type":"Type","label":"PointSeriesRow","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L34"},"signature":["{ [x: string]: any; }"],"initialIsOpen":false},{"id":"def-common.PointSeries","type":"Type","label":"PointSeries","description":["\nA `PointSeries` is a unique structure that represents dots on a chart."],"source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L39"},"signature":["{ type: \"pointseries\"; } & { columns: PointSeriesColumns; rows: PointSeriesRow[]; }"],"initialIsOpen":false},{"id":"def-common.ExpressionValueRender","type":"Type","label":"ExpressionValueRender","description":["\nRepresents an object that is intended to be rendered."],"source":{"path":"src/plugins/expressions/common/expression_types/specs/render.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/render.ts#L16"},"signature":["{ type: \"render\"; } & { as: string; value: T; }"],"initialIsOpen":false},{"id":"def-common.Render","type":"Type","label":"Render","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/render.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/render.ts#L29"},"signature":["{ type: \"render\"; } & { as: string; value: T; }"],"initialIsOpen":false},{"id":"def-common.AnyExpressionFunctionDefinition","type":"Type","label":"AnyExpressionFunctionDefinition","description":["\nType to capture every possible expression function definition."],"source":{"path":"src/plugins/expressions/common/expression_functions/types.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/types.ts#L102"},"signature":["ExpressionFunctionDefinition, any, ExecutionContext<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},">>"],"initialIsOpen":false},{"id":"def-common.ArgumentType","type":"Type","label":"ArgumentType","description":["\nThis type represents all of the possible combinations of properties of an\nArgument in an Expression Function. The presence or absence of certain fields\ninfluence the shape and presence of others within each `arg` in the specification."],"source":{"path":"src/plugins/expressions/common/expression_functions/arguments.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/arguments.ts#L16"},"signature":["SingleArgumentType | MultipleArgumentType | UnresolvedSingleArgumentType | UnresolvedMultipleArgumentType"],"initialIsOpen":false},{"id":"def-common.functionSpecs","type":"Array","label":"functionSpecs","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/index.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/index.ts#L21"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.AnyExpressionFunctionDefinition","text":"AnyExpressionFunctionDefinition"},"[]"],"initialIsOpen":false},{"id":"def-common.MathArguments","type":"Type","label":"MathArguments","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/math.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L15"},"signature":["{ expression: string; onError?: \"null\" | \"false\" | \"zero\" | \"throw\" | undefined; }"],"initialIsOpen":false},{"id":"def-common.MathInput","type":"Type","label":"MathInput","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/math.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L20"},"signature":["number | ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"}],"initialIsOpen":false},{"id":"def-common.ExpressionFunctionClog","type":"Type","label":"ExpressionFunctionClog","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/clog.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/clog.ts#L11"},"signature":["ExpressionFunctionDefinition<\"clog\", unknown, {}, unknown, ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},"<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},">>"],"initialIsOpen":false},{"id":"def-common.ExpressionFunctionFont","type":"Type","label":"ExpressionFunctionFont","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L44"},"signature":["ExpressionFunctionDefinition<\"font\", null, Arguments, ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionTypeStyle","text":"ExpressionTypeStyle"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},"<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},">>"],"initialIsOpen":false},{"id":"def-common.ExpressionFunctionVarSet","type":"Type","label":"ExpressionFunctionVarSet","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/var_set.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L17"},"signature":["ExpressionFunctionDefinition<\"var_set\", unknown, Arguments, unknown, ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},"<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},">>"],"initialIsOpen":false},{"id":"def-common.ExpressionFunctionVar","type":"Type","label":"ExpressionFunctionVar","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/var.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var.ts#L16"},"signature":["ExpressionFunctionDefinition<\"var\", unknown, Arguments, unknown, ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},"<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},">>"],"initialIsOpen":false},{"id":"def-common.ExpressionFunctionTheme","type":"Type","label":"ExpressionFunctionTheme","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/theme.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L20"},"signature":["ExpressionFunctionDefinition<\"theme\", null, Arguments, any, ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},"<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},">>"],"initialIsOpen":false},{"id":"def-common.ExpressionFunctionCumulativeSum","type":"Type","label":"ExpressionFunctionCumulativeSum","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L21"},"signature":["ExpressionFunctionDefinition<\"cumulative_sum\", Datatable, CumulativeSumArgs, Datatable, ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},"<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},">>"],"initialIsOpen":false},{"id":"def-common.ExpressionFunctionDerivative","type":"Type","label":"ExpressionFunctionDerivative","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L21"},"signature":["ExpressionFunctionDefinition<\"derivative\", Datatable, DerivativeArgs, Datatable, ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},"<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},">>"],"initialIsOpen":false},{"id":"def-common.ExpressionFunctionMovingAverage","type":"Type","label":"ExpressionFunctionMovingAverage","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L22"},"signature":["ExpressionFunctionDefinition<\"moving_average\", Datatable, MovingAverageArgs, Datatable, ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},"<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},">>"],"initialIsOpen":false},{"id":"def-common.AnyExpressionRenderDefinition","type":"Type","label":"AnyExpressionRenderDefinition","description":[],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L49"},"signature":["ExpressionRenderDefinition"],"initialIsOpen":false},{"id":"def-common.RenderMode","type":"Type","label":"RenderMode","description":["\nMode of the expression render environment.\nThis value can be set from a consumer embedding an expression renderer and is accessible\nfrom within the active render function as part of the handlers.\nThe following modes are supported:\n* display (default): The chart is rendered in a container with the main purpose of viewing the chart (e.g. in a container like dashboard or canvas)\n* preview: The chart is rendered in very restricted space (below 100px width and height) and should only show a rough outline\n* edit: The chart is rendered within an editor and configuration elements within the chart should be displayed\n* noInteractivity: The chart is rendered in a non-interactive environment and should not provide any affordances for interaction like brushing"],"source":{"path":"src/plugins/expressions/common/expression_renderers/types.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_renderers/types.ts#L61"},"signature":["\"display\" | \"noInteractivity\" | \"edit\" | \"preview\""],"initialIsOpen":false},{"id":"def-common.ExecutorContainer","type":"Type","label":"ExecutorContainer","description":[],"source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L55"},"signature":["StateContainer, ExecutorPureTransitions, ExecutorPureSelectors>"],"initialIsOpen":false},{"id":"def-common.ExecutionContainer","type":"Type","label":"ExecutionContainer","description":[],"source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L73"},"signature":["StateContainer, ExecutionPureTransitions, {}>"],"initialIsOpen":false},{"id":"def-common.ExpressionsServiceSetup","type":"Type","label":"ExpressionsServiceSetup","description":["\nThe public contract that `ExpressionsService` provides to other plugins\nin Kibana Platform in *setup* life-cycle."],"source":{"path":"src/plugins/expressions/common/service/expressions_services.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/service/expressions_services.ts#L26"},"signature":["{ readonly getType: (name: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionType","text":"ExpressionType"}," | undefined; readonly getFunction: (name: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"}," | undefined; readonly getFunctions: () => Record; readonly getRenderer: (name: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionRenderer","text":"ExpressionRenderer"}," | null; readonly getRenderers: () => Record false"],"description":[],"label":"null","source":{"path":"src/plugins/expressions/common/expression_types/specs/boolean.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/boolean.ts#L18"},"returnComment":[]},{"id":"def-common.boolean.from.number","type":"Function","children":[{"type":"Any","label":"n","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/boolean.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/boolean.ts#L19"}}],"signature":["(n: any) => boolean"],"description":[],"label":"number","source":{"path":"src/plugins/expressions/common/expression_types/specs/boolean.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/boolean.ts#L19"},"returnComment":[]},{"id":"def-common.boolean.from.string","type":"Function","children":[{"type":"Any","label":"s","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/boolean.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/boolean.ts#L20"}}],"signature":["(s: any) => boolean"],"description":[],"label":"string","source":{"path":"src/plugins/expressions/common/expression_types/specs/boolean.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/boolean.ts#L20"},"returnComment":[]}],"description":[],"label":"from","source":{"path":"src/plugins/expressions/common/expression_types/specs/boolean.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/boolean.ts#L17"}},{"id":"def-common.boolean.to","type":"Object","children":[{"id":"def-common.boolean.to.render","type":"Function","children":[{"type":"boolean","label":"value","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/boolean.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/boolean.ts#L23"}}],"signature":["(value: boolean) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"render\", { as: string; value: { text: string; }; }>"],"description":[],"label":"render","source":{"path":"src/plugins/expressions/common/expression_types/specs/boolean.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/boolean.ts#L23"},"returnComment":[]},{"id":"def-common.boolean.to.datatable","type":"Function","children":[{"type":"boolean","label":"value","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/boolean.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/boolean.ts#L31"}}],"signature":["(value: boolean) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"}],"description":[],"label":"datatable","source":{"path":"src/plugins/expressions/common/expression_types/specs/boolean.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/boolean.ts#L31"},"returnComment":[]}],"description":[],"label":"to","source":{"path":"src/plugins/expressions/common/expression_types/specs/boolean.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/boolean.ts#L22"}}],"description":[],"label":"boolean","source":{"path":"src/plugins/expressions/common/expression_types/specs/boolean.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/boolean.ts#L15"},"initialIsOpen":false},{"id":"def-common.datatable","type":"Object","children":[{"id":"def-common.datatable.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L116"},"signature":["\"datatable\""]},{"id":"def-common.datatable.validate","type":"Function","children":[{"type":"Any","label":"table","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":117,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L117"}}],"signature":["(table: any) => void"],"description":[],"label":"validate","source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":117,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L117"},"returnComment":[]},{"id":"def-common.datatable.serialize","type":"Function","children":[{"type":"Object","label":"table","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"}],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":127,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L127"}}],"signature":["(table: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"},") => { rows: any[][]; type: \"datatable\"; columns: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.DatatableColumn","text":"DatatableColumn"},"[]; }"],"description":[],"label":"serialize","source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":127,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L127"},"returnComment":[]},{"id":"def-common.datatable.deserialize","type":"Function","children":[{"type":"Object","label":"table","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializedDatatable","text":"SerializedDatatable"}],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":136,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L136"}}],"signature":["(table: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializedDatatable","text":"SerializedDatatable"},") => { rows: _.Dictionary[]; type: \"datatable\"; columns: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.DatatableColumn","text":"DatatableColumn"},"[]; }"],"description":[],"label":"deserialize","source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":136,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L136"},"returnComment":[]},{"id":"def-common.datatable.from","type":"Object","children":[{"id":"def-common.datatable.from.null","type":"Function","children":[],"signature":["() => { type: \"datatable\"; meta: {}; rows: never[]; columns: never[]; }"],"description":[],"label":"null","source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":146,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L146"},"returnComment":[]},{"id":"def-common.datatable.from.pointseries","type":"Function","children":[{"type":"CompoundType","label":"value","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"pointseries\", { columns: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.PointSeriesColumns","text":"PointSeriesColumns"},"; rows: Record[]; }>"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":152,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L152"}}],"signature":["(value: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"pointseries\", { columns: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.PointSeriesColumns","text":"PointSeriesColumns"},"; rows: Record[]; }>) => { type: \"datatable\"; meta: {}; rows: Record[]; columns: { id: string; name: string; meta: { type: \"string\" | \"number\"; }; }[]; }"],"description":[],"label":"pointseries","source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":152,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L152"},"returnComment":[]}],"description":[],"label":"from","source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":145,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L145"}},{"id":"def-common.datatable.to","type":"Object","children":[{"id":"def-common.datatable.to.render","type":"Function","children":[{"type":"Object","label":"table","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"}],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":162,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L162"}}],"signature":["(table: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"},") => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"render\", { as: string; value: RenderedDatatable; }>"],"description":[],"label":"render","source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":162,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L162"},"returnComment":[]},{"id":"def-common.datatable.to.pointseries","type":"Function","children":[{"type":"Object","label":"table","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"}],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":172,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L172"}}],"signature":["(table: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"},") => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"pointseries\", { columns: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.PointSeriesColumns","text":"PointSeriesColumns"},"; rows: Record[]; }>"],"description":[],"label":"pointseries","source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":172,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L172"},"returnComment":[]}],"description":[],"label":"to","source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":161,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L161"}}],"description":[],"label":"datatable","source":{"path":"src/plugins/expressions/common/expression_types/specs/datatable.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/datatable.ts#L115"},"initialIsOpen":false},{"id":"def-common.error","type":"Object","children":[{"id":"def-common.error.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/error.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/error.ts#L36"},"signature":["\"error\""]},{"id":"def-common.error.to","type":"Object","children":[{"id":"def-common.error.to.render","type":"Function","children":[{"type":"CompoundType","label":"input","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"error\", { error: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ErrorLike","text":"ErrorLike"},"; info?: ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined; }>"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/error.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/error.ts#L38"}}],"signature":["(input: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"error\", { error: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ErrorLike","text":"ErrorLike"},"; info?: ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.SerializableState","text":"SerializableState"}," | undefined; }>) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"render\", { as: string; value: Pick<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"}],"description":[],"label":"render","source":{"path":"src/plugins/expressions/common/expression_types/specs/error.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/error.ts#L38"},"returnComment":[]}],"description":[],"label":"to","source":{"path":"src/plugins/expressions/common/expression_types/specs/error.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/error.ts#L37"}}],"description":[],"label":"error","source":{"path":"src/plugins/expressions/common/expression_types/specs/error.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/error.ts#L35"},"initialIsOpen":false},{"id":"def-common.filter","type":"Object","children":[{"id":"def-common.filter.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/filter.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/filter.ts#L28"},"signature":["\"filter\""]},{"id":"def-common.filter.from","type":"Object","children":[{"id":"def-common.filter.from.null","type":"Function","children":[],"signature":["() => { type: \"filter\"; filterType: string; meta: {}; and: never[]; }"],"description":[],"label":"null","source":{"path":"src/plugins/expressions/common/expression_types/specs/filter.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/filter.ts#L30"},"returnComment":[]}],"description":[],"label":"from","source":{"path":"src/plugins/expressions/common/expression_types/specs/filter.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/filter.ts#L29"}}],"description":[],"label":"filter","source":{"path":"src/plugins/expressions/common/expression_types/specs/filter.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/filter.ts#L27"},"initialIsOpen":false},{"id":"def-common.image","type":"Object","children":[{"id":"def-common.image.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/image.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L21"},"signature":["\"image\""]},{"id":"def-common.image.to","type":"Object","children":[{"id":"def-common.image.to.render","type":"Function","children":[{"type":"Object","label":"input","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionImage","text":"ExpressionImage"}],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/image.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L23"}}],"signature":["(input: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionImage","text":"ExpressionImage"},") => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"render\", { as: string; value: Pick<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionImage","text":"ExpressionImage"},", \"dataurl\" | \"mode\">; }>"],"description":[],"label":"render","source":{"path":"src/plugins/expressions/common/expression_types/specs/image.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L23"},"returnComment":[]}],"description":[],"label":"to","source":{"path":"src/plugins/expressions/common/expression_types/specs/image.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L22"}}],"description":[],"label":"image","source":{"path":"src/plugins/expressions/common/expression_types/specs/image.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/image.ts#L20"},"initialIsOpen":false},{"id":"def-common.nullType","type":"Object","children":[{"id":"def-common.nullType.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/null.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/null.ts#L14"},"signature":["\"null\""]},{"id":"def-common.nullType.from","type":"Object","children":[{"id":"def-common.nullType.from.'*'","type":"Function","children":[],"signature":["() => null"],"description":[],"label":"'*'","source":{"path":"src/plugins/expressions/common/expression_types/specs/null.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/null.ts#L16"},"returnComment":[]}],"description":[],"label":"from","source":{"path":"src/plugins/expressions/common/expression_types/specs/null.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/null.ts#L15"}}],"description":[],"label":"nullType","source":{"path":"src/plugins/expressions/common/expression_types/specs/null.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/null.ts#L13"},"initialIsOpen":false},{"id":"def-common.num","type":"Object","children":[{"id":"def-common.num.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/num.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L22"},"signature":["\"num\""]},{"id":"def-common.num.from","type":"Object","children":[{"id":"def-common.num.from.null","type":"Function","children":[],"signature":["() => { type: \"num\"; value: number; }"],"description":[],"label":"null","source":{"path":"src/plugins/expressions/common/expression_types/specs/num.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L24"},"returnComment":[]},{"id":"def-common.num.from.boolean","type":"Function","children":[{"type":"Any","label":"b","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/num.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L28"}}],"signature":["(b: any) => { type: \"num\"; value: number; }"],"description":[],"label":"boolean","source":{"path":"src/plugins/expressions/common/expression_types/specs/num.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L28"},"returnComment":[]},{"id":"def-common.num.from.string","type":"Function","children":[{"type":"Any","label":"n","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/num.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L32"}}],"signature":["(n: any) => { type: \"num\"; value: number; }"],"description":[],"label":"string","source":{"path":"src/plugins/expressions/common/expression_types/specs/num.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L32"},"returnComment":[]},{"id":"def-common.num.from.'*'","type":"Function","children":[{"type":"Any","label":"value","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/num.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L49"}}],"signature":["(value: any) => { type: \"num\"; value: number; }"],"description":[],"label":"'*'","source":{"path":"src/plugins/expressions/common/expression_types/specs/num.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L49"},"returnComment":[]}],"description":[],"label":"from","source":{"path":"src/plugins/expressions/common/expression_types/specs/num.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L23"}},{"id":"def-common.num.to","type":"Object","children":[{"id":"def-common.num.to.render","type":"Function","children":[{"type":"CompoundType","label":"{ value }","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"num\", { value: number; }>"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/num.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L55"}}],"signature":["({ value }: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"num\", { value: number; }>) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"render\", { as: string; value: { text: string; }; }>"],"description":[],"label":"render","source":{"path":"src/plugins/expressions/common/expression_types/specs/num.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L55"},"returnComment":[]},{"id":"def-common.num.to.datatable","type":"Function","children":[{"type":"CompoundType","label":"{ value }","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"num\", { value: number; }>"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/num.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L63"}}],"signature":["({ value }: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"num\", { value: number; }>) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"}],"description":[],"label":"datatable","source":{"path":"src/plugins/expressions/common/expression_types/specs/num.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L63"},"returnComment":[]}],"description":[],"label":"to","source":{"path":"src/plugins/expressions/common/expression_types/specs/num.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L54"}}],"description":[],"label":"num","source":{"path":"src/plugins/expressions/common/expression_types/specs/num.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/num.ts#L21"},"initialIsOpen":false},{"id":"def-common.number","type":"Object","children":[{"id":"def-common.number.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/number.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/number.ts#L17"},"signature":["\"number\""]},{"id":"def-common.number.from","type":"Object","children":[{"id":"def-common.number.from.null","type":"Function","children":[],"signature":["() => number"],"description":[],"label":"null","source":{"path":"src/plugins/expressions/common/expression_types/specs/number.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/number.ts#L19"},"returnComment":[]},{"id":"def-common.number.from.boolean","type":"Function","children":[{"type":"Any","label":"b","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/number.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/number.ts#L20"}}],"signature":["(b: any) => number"],"description":[],"label":"boolean","source":{"path":"src/plugins/expressions/common/expression_types/specs/number.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/number.ts#L20"},"returnComment":[]},{"id":"def-common.number.from.string","type":"Function","children":[{"type":"Any","label":"n","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/number.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/number.ts#L21"}}],"signature":["(n: any) => number"],"description":[],"label":"string","source":{"path":"src/plugins/expressions/common/expression_types/specs/number.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/number.ts#L21"},"returnComment":[]}],"description":[],"label":"from","source":{"path":"src/plugins/expressions/common/expression_types/specs/number.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/number.ts#L18"}},{"id":"def-common.number.to","type":"Object","children":[{"id":"def-common.number.to.render","type":"Function","children":[{"type":"number","label":"value","isRequired":true,"signature":["number"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/number.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/number.ts#L37"}}],"signature":["(value: number) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"render\", { as: string; value: { text: string; }; }>"],"description":[],"label":"render","source":{"path":"src/plugins/expressions/common/expression_types/specs/number.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/number.ts#L37"},"returnComment":[]},{"id":"def-common.number.to.datatable","type":"Function","children":[{"type":"number","label":"value","isRequired":true,"signature":["number"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/number.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/number.ts#L45"}}],"signature":["(value: number) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"}],"description":[],"label":"datatable","source":{"path":"src/plugins/expressions/common/expression_types/specs/number.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/number.ts#L45"},"returnComment":[]}],"description":[],"label":"to","source":{"path":"src/plugins/expressions/common/expression_types/specs/number.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/number.ts#L36"}}],"description":[],"label":"number","source":{"path":"src/plugins/expressions/common/expression_types/specs/number.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/number.ts#L16"},"initialIsOpen":false},{"id":"def-common.pointseries","type":"Object","children":[{"id":"def-common.pointseries.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L48"},"signature":["\"pointseries\""]},{"id":"def-common.pointseries.from","type":"Object","children":[{"id":"def-common.pointseries.from.null","type":"Function","children":[],"signature":["() => { type: \"pointseries\"; rows: never[]; columns: {}; }"],"description":[],"label":"null","source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L50"},"returnComment":[]}],"description":[],"label":"from","source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L49"}},{"id":"def-common.pointseries.to","type":"Object","children":[{"id":"def-common.pointseries.to.render","type":"Function","children":[{"type":"CompoundType","label":"pseries","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"pointseries\", { columns: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.PointSeriesColumns","text":"PointSeriesColumns"},"; rows: Record[]; }>"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L60"}},{"type":"Object","label":"types","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L61"}}],"signature":["(pseries: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"pointseries\", { columns: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.PointSeriesColumns","text":"PointSeriesColumns"},"; rows: Record[]; }>, types: Record) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"render\", { as: string; value: { datatable: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"},"; showHeader: boolean; }; }>"],"description":[],"label":"render","source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L59"},"returnComment":[]}],"description":[],"label":"to","source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L58"}}],"description":[],"label":"pointseries","source":{"path":"src/plugins/expressions/common/expression_types/specs/pointseries.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/pointseries.ts#L47"},"initialIsOpen":false},{"id":"def-common.range","type":"Object","children":[{"id":"def-common.range.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/range.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L22"},"signature":["\"range\""]},{"id":"def-common.range.from","type":"Object","children":[{"id":"def-common.range.from.null","type":"Function","children":[],"signature":["() => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Range","text":"Range"}],"description":[],"label":"null","source":{"path":"src/plugins/expressions/common/expression_types/specs/range.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L24"},"returnComment":[]}],"description":[],"label":"from","source":{"path":"src/plugins/expressions/common/expression_types/specs/range.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L23"}},{"id":"def-common.range.to","type":"Object","children":[{"id":"def-common.range.to.render","type":"Function","children":[{"type":"Object","label":"value","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Range","text":"Range"}],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/range.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L33"}}],"signature":["(value: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Range","text":"Range"},") => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"render\", { as: string; value: { text: string; }; }>"],"description":[],"label":"render","source":{"path":"src/plugins/expressions/common/expression_types/specs/range.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L33"},"returnComment":[]}],"description":[],"label":"to","source":{"path":"src/plugins/expressions/common/expression_types/specs/range.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L32"}}],"description":[],"label":"range","source":{"path":"src/plugins/expressions/common/expression_types/specs/range.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/range.ts#L21"},"initialIsOpen":false},{"id":"def-common.render","type":"Object","children":[{"id":"def-common.render.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/render.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/render.ts#L32"},"signature":["\"render\""]},{"id":"def-common.render.from","type":"Object","children":[{"id":"def-common.render.from.'*'","type":"Function","children":[{"type":"Uncategorized","label":"v","isRequired":true,"signature":["T"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/render.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/render.ts#L34"}}],"signature":["(v: T) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"render\", { as: string; value: T; }>"],"description":[],"label":"'*'","source":{"path":"src/plugins/expressions/common/expression_types/specs/render.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/render.ts#L34"},"returnComment":[]}],"description":[],"label":"from","source":{"path":"src/plugins/expressions/common/expression_types/specs/render.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/render.ts#L33"}}],"description":[],"label":"render","source":{"path":"src/plugins/expressions/common/expression_types/specs/render.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/render.ts#L31"},"initialIsOpen":false},{"id":"def-common.shape","type":"Object","children":[{"id":"def-common.shape.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/shape.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/shape.ts#L15"},"signature":["\"shape\""]},{"id":"def-common.shape.to","type":"Object","children":[{"id":"def-common.shape.to.render","type":"Function","children":[{"type":"CompoundType","label":"input","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"render\", { as: string; value: any; }>"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/shape.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/shape.ts#L17"}}],"signature":["(input: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"render\", { as: string; value: any; }>) => { type: string; as: string; value: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"render\", { as: string; value: any; }>; }"],"description":[],"label":"render","source":{"path":"src/plugins/expressions/common/expression_types/specs/shape.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/shape.ts#L17"},"returnComment":[]}],"description":[],"label":"to","source":{"path":"src/plugins/expressions/common/expression_types/specs/shape.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/shape.ts#L16"}}],"description":[],"label":"shape","source":{"path":"src/plugins/expressions/common/expression_types/specs/shape.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/shape.ts#L14"},"initialIsOpen":false},{"id":"def-common.string","type":"Object","children":[{"id":"def-common.string.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/string.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/string.ts#L16"},"signature":["\"string\""]},{"id":"def-common.string.from","type":"Object","children":[{"id":"def-common.string.from.null","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"null","source":{"path":"src/plugins/expressions/common/expression_types/specs/string.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/string.ts#L18"},"returnComment":[]},{"id":"def-common.string.from.boolean","type":"Function","children":[{"type":"Any","label":"b","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/string.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/string.ts#L19"}}],"signature":["(b: any) => string"],"description":[],"label":"boolean","source":{"path":"src/plugins/expressions/common/expression_types/specs/string.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/string.ts#L19"},"returnComment":[]},{"id":"def-common.string.from.number","type":"Function","children":[{"type":"Any","label":"n","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/string.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/string.ts#L20"}}],"signature":["(n: any) => string"],"description":[],"label":"number","source":{"path":"src/plugins/expressions/common/expression_types/specs/string.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/string.ts#L20"},"returnComment":[]}],"description":[],"label":"from","source":{"path":"src/plugins/expressions/common/expression_types/specs/string.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/string.ts#L17"}},{"id":"def-common.string.to","type":"Object","children":[{"id":"def-common.string.to.render","type":"Function","children":[{"type":"Uncategorized","label":"text","isRequired":true,"signature":["T"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/string.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/string.ts#L23"}}],"signature":["(text: T) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionValueBoxed","text":"ExpressionValueBoxed"},"<\"render\", { as: string; value: { text: T; }; }>"],"description":[],"label":"render","source":{"path":"src/plugins/expressions/common/expression_types/specs/string.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/string.ts#L23"},"returnComment":[]},{"id":"def-common.string.to.datatable","type":"Function","children":[{"type":"string","label":"value","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/string.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/string.ts#L30"}}],"signature":["(value: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"}],"description":[],"label":"datatable","source":{"path":"src/plugins/expressions/common/expression_types/specs/string.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/string.ts#L30"},"returnComment":[]}],"description":[],"label":"to","source":{"path":"src/plugins/expressions/common/expression_types/specs/string.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/string.ts#L22"}}],"description":[],"label":"string","source":{"path":"src/plugins/expressions/common/expression_types/specs/string.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/string.ts#L15"},"initialIsOpen":false},{"id":"def-common.style","type":"Object","children":[{"id":"def-common.style.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_types/specs/style.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/style.ts#L15"},"signature":["\"style\""]},{"id":"def-common.style.from","type":"Object","children":[{"id":"def-common.style.from.null","type":"Function","children":[],"signature":["() => { type: \"style\"; spec: {}; css: string; }"],"description":[],"label":"null","source":{"path":"src/plugins/expressions/common/expression_types/specs/style.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/style.ts#L17"},"returnComment":[]}],"description":[],"label":"from","source":{"path":"src/plugins/expressions/common/expression_types/specs/style.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/style.ts#L16"}}],"description":[],"label":"style","source":{"path":"src/plugins/expressions/common/expression_types/specs/style.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_types/specs/style.ts#L14"},"initialIsOpen":false},{"id":"def-common.mapColumn","type":"Object","children":[{"id":"def-common.mapColumn.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L26"},"signature":["\"mapColumn\""]},{"id":"def-common.mapColumn.aliases","type":"Array","label":"aliases","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L27"},"signature":["string[]"]},{"id":"def-common.mapColumn.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L28"},"signature":["\"datatable\""]},{"id":"def-common.mapColumn.inputTypes","type":"Array","label":"inputTypes","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L29"},"signature":["\"datatable\"[]"]},{"id":"def-common.mapColumn.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L30"}},{"id":"def-common.mapColumn.args","type":"Object","children":[{"id":"def-common.mapColumn.args.id","type":"Object","children":[{"id":"def-common.mapColumn.args.id.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L42"},"signature":["(\"string\" | \"null\")[]"]},{"id":"def-common.mapColumn.args.id.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L43"}},{"id":"def-common.mapColumn.args.id.required","type":"boolean","label":"required","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L47"},"signature":["false"]},{"id":"def-common.mapColumn.args.id.default","type":"Uncategorized","label":"default","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L48"},"signature":["null"]}],"description":[],"label":"id","source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L41"}},{"id":"def-common.mapColumn.args.name","type":"Object","children":[{"id":"def-common.mapColumn.args.name.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L51"},"signature":["\"string\"[]"]},{"id":"def-common.mapColumn.args.name.aliases","type":"Array","label":"aliases","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L52"},"signature":["string[]"]},{"id":"def-common.mapColumn.args.name.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L53"}},{"id":"def-common.mapColumn.args.name.required","type":"boolean","label":"required","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L56"},"signature":["true"]}],"description":[],"label":"name","source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L50"}},{"id":"def-common.mapColumn.args.expression","type":"Object","children":[{"id":"def-common.mapColumn.args.expression.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L59"},"signature":["(\"boolean\" | \"string\" | \"number\" | \"null\")[]"]},{"id":"def-common.mapColumn.args.expression.resolve","type":"boolean","label":"resolve","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L60"},"signature":["false"]},{"id":"def-common.mapColumn.args.expression.aliases","type":"Array","label":"aliases","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L61"},"signature":["string[]"]},{"id":"def-common.mapColumn.args.expression.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L62"}},{"id":"def-common.mapColumn.args.expression.required","type":"boolean","label":"required","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L69"},"signature":["true"]}],"description":[],"label":"expression","source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L58"}},{"id":"def-common.mapColumn.args.copyMetaFrom","type":"Object","children":[{"id":"def-common.mapColumn.args.copyMetaFrom.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L72"},"signature":["(\"string\" | \"null\")[]"]},{"id":"def-common.mapColumn.args.copyMetaFrom.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L73"}},{"id":"def-common.mapColumn.args.copyMetaFrom.required","type":"boolean","label":"required","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L77"},"signature":["false"]},{"id":"def-common.mapColumn.args.copyMetaFrom.default","type":"Uncategorized","label":"default","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L78"},"signature":["null"]}],"description":[],"label":"copyMetaFrom","source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L71"}}],"description":[],"label":"args","source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L40"}},{"id":"def-common.mapColumn.fn","type":"Function","children":[{"type":"Object","label":"input","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"}],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L81"}},{"type":"Object","label":"args","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.MapColumnArguments","text":"MapColumnArguments"}],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L81"}}],"signature":["(input: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"},", args: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.MapColumnArguments","text":"MapColumnArguments"},") => Promise<",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"},">"],"description":[],"label":"fn","source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L81"},"returnComment":[]}],"description":[],"label":"mapColumn","source":{"path":"src/plugins/expressions/common/expression_functions/specs/map_column.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/map_column.ts#L20"},"initialIsOpen":false},{"id":"def-common.math","type":"Object","children":[{"id":"def-common.math.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/math.ts","lineNumber":85,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L85"},"signature":["\"math\""]},{"id":"def-common.math.type","type":"Uncategorized","label":"type","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/math.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L86"},"signature":["undefined"]},{"id":"def-common.math.inputTypes","type":"Array","label":"inputTypes","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/math.ts","lineNumber":87,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L87"},"signature":["(\"number\" | \"datatable\")[]"]},{"id":"def-common.math.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/math.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L88"}},{"id":"def-common.math.args","type":"Object","children":[{"id":"def-common.math.args.expression","type":"Object","children":[{"id":"def-common.math.args.expression.aliases","type":"Array","label":"aliases","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/math.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L103"},"signature":["string[]"]},{"id":"def-common.math.args.expression.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/math.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L104"},"signature":["\"string\"[]"]},{"id":"def-common.math.args.expression.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/math.ts","lineNumber":105,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L105"}}],"description":[],"label":"expression","source":{"path":"src/plugins/expressions/common/expression_functions/specs/math.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L102"}},{"id":"def-common.math.args.onError","type":"Object","children":[{"id":"def-common.math.args.onError.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/math.ts","lineNumber":114,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L114"},"signature":["\"string\"[]"]},{"id":"def-common.math.args.onError.options","type":"Array","label":"options","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/math.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L115"},"signature":["(\"null\" | \"false\" | \"zero\" | \"throw\")[]"]},{"id":"def-common.math.args.onError.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/math.ts","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L116"}}],"description":[],"label":"onError","source":{"path":"src/plugins/expressions/common/expression_functions/specs/math.ts","lineNumber":113,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L113"}}],"description":[],"label":"args","source":{"path":"src/plugins/expressions/common/expression_functions/specs/math.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L101"}},{"id":"def-common.math.fn","type":"Function","children":[{"type":"CompoundType","label":"input","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.MathInput","text":"MathInput"}],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/math.ts","lineNumber":125,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L125"}},{"type":"Object","label":"args","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.MathArguments","text":"MathArguments"}],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/math.ts","lineNumber":125,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L125"}}],"signature":["(input: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.MathInput","text":"MathInput"},", args: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.MathArguments","text":"MathArguments"},") => number | false | null"],"description":[],"label":"fn","source":{"path":"src/plugins/expressions/common/expression_functions/specs/math.ts","lineNumber":125,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L125"},"returnComment":[]}],"description":[],"label":"math","source":{"path":"src/plugins/expressions/common/expression_functions/specs/math.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/math.ts#L79"},"initialIsOpen":false},{"id":"def-common.clog","type":"Object","children":[{"id":"def-common.clog.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/clog.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/clog.ts#L14"},"signature":["\"clog\""]},{"id":"def-common.clog.args","type":"Object","children":[],"description":[],"label":"args","source":{"path":"src/plugins/expressions/common/expression_functions/specs/clog.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/clog.ts#L15"}},{"id":"def-common.clog.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/clog.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/clog.ts#L16"}},{"id":"def-common.clog.fn","type":"Function","children":[{"type":"Unknown","label":"input","isRequired":true,"signature":["unknown"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/clog.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/clog.ts#L17"}}],"signature":["(input: unknown) => unknown"],"description":[],"label":"fn","source":{"path":"src/plugins/expressions/common/expression_functions/specs/clog.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/clog.ts#L17"},"returnComment":[]}],"description":[],"label":"clog","source":{"path":"src/plugins/expressions/common/expression_functions/specs/clog.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/clog.ts#L13"},"initialIsOpen":false},{"id":"def-common.font","type":"Object","children":[{"id":"def-common.font.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L47"},"signature":["\"font\""]},{"id":"def-common.font.aliases","type":"Array","label":"aliases","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L48"},"signature":["never[]"]},{"id":"def-common.font.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L49"},"signature":["\"style\""]},{"id":"def-common.font.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L50"}},{"id":"def-common.font.inputTypes","type":"Array","label":"inputTypes","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L53"},"signature":["\"null\"[]"]},{"id":"def-common.font.args","type":"Object","children":[{"id":"def-common.font.args.align","type":"Object","children":[{"id":"def-common.font.args.align.default","type":"string","label":"default","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L56"}},{"id":"def-common.font.args.align.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L57"}},{"id":"def-common.font.args.align.options","type":"Array","label":"options","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L60"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.TextAlignment","text":"TextAlignment"},"[]"]},{"id":"def-common.font.args.align.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L61"},"signature":["\"string\"[]"]}],"description":[],"label":"align","source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L55"}},{"id":"def-common.font.args.color","type":"Object","children":[{"id":"def-common.font.args.color.default","type":"string","label":"default","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L64"}},{"id":"def-common.font.args.color.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L65"}},{"id":"def-common.font.args.color.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L68"},"signature":["\"string\"[]"]}],"description":[],"label":"color","source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L63"}},{"id":"def-common.font.args.family","type":"Object","children":[{"id":"def-common.font.args.family.default","type":"string","label":"default","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L71"}},{"id":"def-common.font.args.family.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L72"}},{"id":"def-common.font.args.family.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L78"},"signature":["\"string\"[]"]}],"description":[],"label":"family","source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L70"}},{"id":"def-common.font.args.italic","type":"Object","children":[{"id":"def-common.font.args.italic.default","type":"string","label":"default","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L81"}},{"id":"def-common.font.args.italic.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L82"}},{"id":"def-common.font.args.italic.options","type":"Array","label":"options","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":85,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L85"},"signature":["boolean[]"]},{"id":"def-common.font.args.italic.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L86"},"signature":["\"boolean\"[]"]}],"description":[],"label":"italic","source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L80"}},{"id":"def-common.font.args.lHeight","type":"Object","children":[{"id":"def-common.font.args.lHeight.default","type":"string","label":"default","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L89"}},{"id":"def-common.font.args.lHeight.aliases","type":"Array","label":"aliases","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L90"},"signature":["string[]"]},{"id":"def-common.font.args.lHeight.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":91,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L91"}},{"id":"def-common.font.args.lHeight.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L94"},"signature":["(\"number\" | \"null\")[]"]}],"description":[],"label":"lHeight","source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L88"}},{"id":"def-common.font.args.size","type":"Object","children":[{"id":"def-common.font.args.size.default","type":"string","label":"default","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L97"}},{"id":"def-common.font.args.size.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L98"}},{"id":"def-common.font.args.size.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L101"},"signature":["\"number\"[]"]}],"description":[],"label":"size","source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L96"}},{"id":"def-common.font.args.underline","type":"Object","children":[{"id":"def-common.font.args.underline.default","type":"string","label":"default","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L104"}},{"id":"def-common.font.args.underline.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":105,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L105"}},{"id":"def-common.font.args.underline.options","type":"Array","label":"options","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L108"},"signature":["boolean[]"]},{"id":"def-common.font.args.underline.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":109,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L109"},"signature":["\"boolean\"[]"]}],"description":[],"label":"underline","source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L103"}},{"id":"def-common.font.args.weight","type":"Object","children":[{"id":"def-common.font.args.weight.default","type":"string","label":"default","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":112,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L112"}},{"id":"def-common.font.args.weight.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":113,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L113"}},{"id":"def-common.font.args.weight.options","type":"Array","label":"options","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":123,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L123"},"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.FontWeight","text":"FontWeight"},"[]"]},{"id":"def-common.font.args.weight.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":124,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L124"},"signature":["\"string\"[]"]}],"description":[],"label":"weight","source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":111,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L111"}}],"description":[],"label":"args","source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L54"}},{"id":"def-common.font.fn","type":"Function","children":[{"type":"Uncategorized","label":"input","isRequired":true,"signature":["null"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":127,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L127"}},{"type":"Object","label":"args","isRequired":true,"signature":["Arguments"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":127,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L127"}}],"signature":["(input: null, args: Arguments) => { type: \"style\"; spec: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.CSSStyle","text":"CSSStyle"},"; css: string; }"],"description":[],"label":"fn","source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":127,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L127"},"returnComment":[]}],"description":[],"label":"font","source":{"path":"src/plugins/expressions/common/expression_functions/specs/font.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/font.ts#L46"},"initialIsOpen":false},{"id":"def-common.variableSet","type":"Object","children":[{"id":"def-common.variableSet.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/var_set.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L25"},"signature":["\"var_set\""]},{"id":"def-common.variableSet.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/var_set.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L26"}},{"id":"def-common.variableSet.args","type":"Object","children":[{"id":"def-common.variableSet.args.name","type":"Object","children":[{"id":"def-common.variableSet.args.name.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/var_set.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L31"},"signature":["\"string\"[]"]},{"id":"def-common.variableSet.args.name.aliases","type":"Array","label":"aliases","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/var_set.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L32"},"signature":["string[]"]},{"id":"def-common.variableSet.args.name.required","type":"boolean","label":"required","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/var_set.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L33"},"signature":["true"]},{"id":"def-common.variableSet.args.name.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/var_set.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L34"}}],"description":[],"label":"name","source":{"path":"src/plugins/expressions/common/expression_functions/specs/var_set.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L30"}},{"id":"def-common.variableSet.args.value","type":"Object","children":[{"id":"def-common.variableSet.args.value.aliases","type":"Array","label":"aliases","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/var_set.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L39"},"signature":["string[]"]},{"id":"def-common.variableSet.args.value.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/var_set.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L40"}}],"description":[],"label":"value","source":{"path":"src/plugins/expressions/common/expression_functions/specs/var_set.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L38"}}],"description":[],"label":"args","source":{"path":"src/plugins/expressions/common/expression_functions/specs/var_set.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L29"}},{"id":"def-common.variableSet.fn","type":"Function","label":"fn","signature":["(input: unknown, args: Arguments, context: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},"<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},">) => unknown"],"description":[],"children":[{"type":"Unknown","label":"input","isRequired":true,"signature":["unknown"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/var_set.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L46"}},{"type":"Object","label":"args","isRequired":true,"signature":["Arguments"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/var_set.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L46"}},{"type":"Object","label":"context","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},"<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},">"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/var_set.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L46"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/var_set.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L46"}}],"description":[],"label":"variableSet","source":{"path":"src/plugins/expressions/common/expression_functions/specs/var_set.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var_set.ts#L24"},"initialIsOpen":false},{"id":"def-common.variable","type":"Object","children":[{"id":"def-common.variable.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/var.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var.ts#L24"},"signature":["\"var\""]},{"id":"def-common.variable.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/var.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var.ts#L25"}},{"id":"def-common.variable.args","type":"Object","children":[{"id":"def-common.variable.args.name","type":"Object","children":[{"id":"def-common.variable.args.name.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/var.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var.ts#L30"},"signature":["\"string\"[]"]},{"id":"def-common.variable.args.name.aliases","type":"Array","label":"aliases","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/var.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var.ts#L31"},"signature":["string[]"]},{"id":"def-common.variable.args.name.required","type":"boolean","label":"required","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/var.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var.ts#L32"},"signature":["true"]},{"id":"def-common.variable.args.name.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/var.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var.ts#L33"}}],"description":[],"label":"name","source":{"path":"src/plugins/expressions/common/expression_functions/specs/var.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var.ts#L29"}}],"description":[],"label":"args","source":{"path":"src/plugins/expressions/common/expression_functions/specs/var.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var.ts#L28"}},{"id":"def-common.variable.fn","type":"Function","label":"fn","signature":["(input: unknown, args: Arguments, context: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},"<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},">) => any"],"description":[],"children":[{"type":"Unknown","label":"input","isRequired":true,"signature":["unknown"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/var.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var.ts#L38"}},{"type":"Object","label":"args","isRequired":true,"signature":["Arguments"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/var.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var.ts#L38"}},{"type":"Object","label":"context","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},"<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},">"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/var.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var.ts#L38"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/var.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var.ts#L38"}}],"description":[],"label":"variable","source":{"path":"src/plugins/expressions/common/expression_functions/specs/var.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/var.ts#L23"},"initialIsOpen":false},{"id":"def-common.theme","type":"Object","children":[{"id":"def-common.theme.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/theme.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L28"},"signature":["\"theme\""]},{"id":"def-common.theme.aliases","type":"Array","label":"aliases","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/theme.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L29"},"signature":["never[]"]},{"id":"def-common.theme.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/theme.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L30"}},{"id":"def-common.theme.inputTypes","type":"Array","label":"inputTypes","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/theme.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L33"},"signature":["\"null\"[]"]},{"id":"def-common.theme.args","type":"Object","children":[{"id":"def-common.theme.args.variable","type":"Object","children":[{"id":"def-common.theme.args.variable.aliases","type":"Array","label":"aliases","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/theme.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L36"},"signature":["string[]"]},{"id":"def-common.theme.args.variable.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/theme.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L37"}},{"id":"def-common.theme.args.variable.required","type":"boolean","label":"required","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/theme.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L40"},"signature":["true"]},{"id":"def-common.theme.args.variable.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/theme.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L41"},"signature":["\"string\"[]"]}],"description":[],"label":"variable","source":{"path":"src/plugins/expressions/common/expression_functions/specs/theme.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L35"}},{"id":"def-common.theme.args.default","type":"Object","children":[{"id":"def-common.theme.args.default.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/theme.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L44"}}],"description":[],"label":"default","source":{"path":"src/plugins/expressions/common/expression_functions/specs/theme.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L43"}}],"description":[],"label":"args","source":{"path":"src/plugins/expressions/common/expression_functions/specs/theme.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L34"}},{"id":"def-common.theme.fn","type":"Function","children":[{"type":"Uncategorized","label":"input","isRequired":true,"signature":["null"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/theme.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L49"}},{"type":"Object","label":"args","isRequired":true,"signature":["Arguments"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/theme.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L49"}},{"type":"Object","label":"handlers","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},"<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},">"],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/theme.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L49"}}],"signature":["(input: null, args: Arguments, handlers: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionContext","text":"ExecutionContext"},"<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.SerializableState","text":"SerializableState"},">) => any"],"description":[],"label":"fn","source":{"path":"src/plugins/expressions/common/expression_functions/specs/theme.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L49"},"returnComment":[]}],"description":[],"label":"theme","source":{"path":"src/plugins/expressions/common/expression_functions/specs/theme.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/theme.ts#L27"},"initialIsOpen":false},{"id":"def-common.cumulativeSum","type":"Object","children":[{"id":"def-common.cumulativeSum.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L56"},"signature":["\"cumulative_sum\""]},{"id":"def-common.cumulativeSum.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L57"},"signature":["\"datatable\""]},{"id":"def-common.cumulativeSum.inputTypes","type":"Array","label":"inputTypes","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L59"},"signature":["\"datatable\"[]"]},{"id":"def-common.cumulativeSum.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L61"}},{"id":"def-common.cumulativeSum.args","type":"Object","children":[{"id":"def-common.cumulativeSum.args.by","type":"Object","children":[{"id":"def-common.cumulativeSum.args.by.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L67"}},{"id":"def-common.cumulativeSum.args.by.multi","type":"boolean","label":"multi","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L70"},"signature":["true"]},{"id":"def-common.cumulativeSum.args.by.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L71"},"signature":["\"string\"[]"]},{"id":"def-common.cumulativeSum.args.by.required","type":"boolean","label":"required","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L72"},"signature":["false"]}],"description":[],"label":"by","source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L66"}},{"id":"def-common.cumulativeSum.args.inputColumnId","type":"Object","children":[{"id":"def-common.cumulativeSum.args.inputColumnId.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L75"}},{"id":"def-common.cumulativeSum.args.inputColumnId.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L78"},"signature":["\"string\"[]"]},{"id":"def-common.cumulativeSum.args.inputColumnId.required","type":"boolean","label":"required","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L79"},"signature":["true"]}],"description":[],"label":"inputColumnId","source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L74"}},{"id":"def-common.cumulativeSum.args.outputColumnId","type":"Object","children":[{"id":"def-common.cumulativeSum.args.outputColumnId.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L82"}},{"id":"def-common.cumulativeSum.args.outputColumnId.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":85,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L85"},"signature":["\"string\"[]"]},{"id":"def-common.cumulativeSum.args.outputColumnId.required","type":"boolean","label":"required","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L86"},"signature":["true"]}],"description":[],"label":"outputColumnId","source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L81"}},{"id":"def-common.cumulativeSum.args.outputColumnName","type":"Object","children":[{"id":"def-common.cumulativeSum.args.outputColumnName.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L89"}},{"id":"def-common.cumulativeSum.args.outputColumnName.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L92"},"signature":["\"string\"[]"]},{"id":"def-common.cumulativeSum.args.outputColumnName.required","type":"boolean","label":"required","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":93,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L93"},"signature":["false"]}],"description":[],"label":"outputColumnName","source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L88"}}],"description":[],"label":"args","source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L65"}},{"id":"def-common.cumulativeSum.fn","type":"Function","label":"fn","signature":["(input: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"},", { by, inputColumnId, outputColumnId, outputColumnName }: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.CumulativeSumArgs","text":"CumulativeSumArgs"},") => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"}],"description":[],"children":[{"type":"Object","label":"input","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"}],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L97"}},{"type":"Object","label":"{ by, inputColumnId, outputColumnId, outputColumnName }","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.CumulativeSumArgs","text":"CumulativeSumArgs"}],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L97"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L97"}}],"description":["\nCalculates the cumulative sum of a specified column in the data table.\n\nAlso supports multiple series in a single data table - use the `by` argument\nto specify the columns to split the calculation by.\nFor each unique combination of all `by` columns a separate cumulative sum will be calculated.\nThe order of rows won't be changed - this function is not modifying any existing columns, it's only\nadding the specified `outputColumnId` column to every row of the table without adding or removing rows.\n\nBehavior:\n* Will write the cumulative sum of `inputColumnId` into `outputColumnId`\n* If provided will use `outputColumnName` as name for the newly created column. Otherwise falls back to `outputColumnId`\n* Cumulative sums always start with 0, a cell will contain its own value plus the values of\n all cells of the same series further up in the table.\n\nEdge cases:\n* Will return the input table if `inputColumnId` does not exist\n* Will throw an error if `outputColumnId` exists already in provided data table\n* If the row value contains `null` or `undefined`, it will be ignored and overwritten with the cumulative sum of\n all cells of the same series further up in the table.\n* For all values besides `null` and `undefined`, the value will be cast to a number before it's added to the\n cumulative sum of the current series - if this results in `NaN` (like in case of objects), all cells of the\n current series will be set to `NaN`.\n* To determine separate series defined by the `by` columns, the values of these columns will be cast to strings\n before comparison. If the values are objects, the return value of their `toString` method will be used for comparison.\n Missing values (`null` and `undefined`) will be treated as empty strings."],"label":"cumulativeSum","source":{"path":"src/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/cumulative_sum.ts#L55"},"initialIsOpen":false},{"id":"def-common.derivative","type":"Object","children":[{"id":"def-common.derivative.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L57"},"signature":["\"derivative\""]},{"id":"def-common.derivative.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L58"},"signature":["\"datatable\""]},{"id":"def-common.derivative.inputTypes","type":"Array","label":"inputTypes","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L60"},"signature":["\"datatable\"[]"]},{"id":"def-common.derivative.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L62"}},{"id":"def-common.derivative.args","type":"Object","children":[{"id":"def-common.derivative.args.by","type":"Object","children":[{"id":"def-common.derivative.args.by.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L68"}},{"id":"def-common.derivative.args.by.multi","type":"boolean","label":"multi","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L71"},"signature":["true"]},{"id":"def-common.derivative.args.by.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L72"},"signature":["\"string\"[]"]},{"id":"def-common.derivative.args.by.required","type":"boolean","label":"required","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L73"},"signature":["false"]}],"description":[],"label":"by","source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L67"}},{"id":"def-common.derivative.args.inputColumnId","type":"Object","children":[{"id":"def-common.derivative.args.inputColumnId.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":76,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L76"}},{"id":"def-common.derivative.args.inputColumnId.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L79"},"signature":["\"string\"[]"]},{"id":"def-common.derivative.args.inputColumnId.required","type":"boolean","label":"required","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L80"},"signature":["true"]}],"description":[],"label":"inputColumnId","source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L75"}},{"id":"def-common.derivative.args.outputColumnId","type":"Object","children":[{"id":"def-common.derivative.args.outputColumnId.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L83"}},{"id":"def-common.derivative.args.outputColumnId.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L86"},"signature":["\"string\"[]"]},{"id":"def-common.derivative.args.outputColumnId.required","type":"boolean","label":"required","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":87,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L87"},"signature":["true"]}],"description":[],"label":"outputColumnId","source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L82"}},{"id":"def-common.derivative.args.outputColumnName","type":"Object","children":[{"id":"def-common.derivative.args.outputColumnName.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L90"}},{"id":"def-common.derivative.args.outputColumnName.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":93,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L93"},"signature":["\"string\"[]"]},{"id":"def-common.derivative.args.outputColumnName.required","type":"boolean","label":"required","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L94"},"signature":["false"]}],"description":[],"label":"outputColumnName","source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L89"}}],"description":[],"label":"args","source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L66"}},{"id":"def-common.derivative.fn","type":"Function","label":"fn","signature":["(input: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"},", { by, inputColumnId, outputColumnId, outputColumnName }: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.DerivativeArgs","text":"DerivativeArgs"},") => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"}],"description":[],"children":[{"type":"Object","label":"input","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"}],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L98"}},{"type":"Object","label":"{ by, inputColumnId, outputColumnId, outputColumnName }","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.DerivativeArgs","text":"DerivativeArgs"}],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L98"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L98"}}],"description":["\nCalculates the derivative of a specified column in the data table.\n\nAlso supports multiple series in a single data table - use the `by` argument\nto specify the columns to split the calculation by.\nFor each unique combination of all `by` columns a separate derivative will be calculated.\nThe order of rows won't be changed - this function is not modifying any existing columns, it's only\nadding the specified `outputColumnId` column to every row of the table without adding or removing rows.\n\nBehavior:\n* Will write the derivative of `inputColumnId` into `outputColumnId`\n* If provided will use `outputColumnName` as name for the newly created column. Otherwise falls back to `outputColumnId`\n* Derivative always start with an undefined value for the first row of a series, a cell will contain its own value minus the\n value of the previous cell of the same series.\n\nEdge cases:\n* Will return the input table if `inputColumnId` does not exist\n* Will throw an error if `outputColumnId` exists already in provided data table\n* If there is no previous row of the current series with a non `null` or `undefined` value, the output cell of the current row\n will be set to `undefined`.\n* If the row value contains `null` or `undefined`, it will be ignored and the output cell will be set to `undefined`\n* If the value of the previous row of the same series contains `null` or `undefined`, the output cell of the current row will be set to `undefined` as well\n* For all values besides `null` and `undefined`, the value will be cast to a number before it's used in the\n calculation of the current series even if this results in `NaN` (like in case of objects).\n* To determine separate series defined by the `by` columns, the values of these columns will be cast to strings\n before comparison. If the values are objects, the return value of their `toString` method will be used for comparison.\n Missing values (`null` and `undefined`) will be treated as empty strings."],"label":"derivative","source":{"path":"src/plugins/expressions/common/expression_functions/specs/derivative.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/derivative.ts#L56"},"initialIsOpen":false},{"id":"def-common.movingAverage","type":"Object","children":[{"id":"def-common.movingAverage.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L55"},"signature":["\"moving_average\""]},{"id":"def-common.movingAverage.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L56"},"signature":["\"datatable\""]},{"id":"def-common.movingAverage.inputTypes","type":"Array","label":"inputTypes","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L58"},"signature":["\"datatable\"[]"]},{"id":"def-common.movingAverage.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L60"}},{"id":"def-common.movingAverage.args","type":"Object","children":[{"id":"def-common.movingAverage.args.by","type":"Object","children":[{"id":"def-common.movingAverage.args.by.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L66"}},{"id":"def-common.movingAverage.args.by.multi","type":"boolean","label":"multi","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L69"},"signature":["true"]},{"id":"def-common.movingAverage.args.by.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L70"},"signature":["\"string\"[]"]},{"id":"def-common.movingAverage.args.by.required","type":"boolean","label":"required","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L71"},"signature":["false"]}],"description":[],"label":"by","source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L65"}},{"id":"def-common.movingAverage.args.inputColumnId","type":"Object","children":[{"id":"def-common.movingAverage.args.inputColumnId.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L74"}},{"id":"def-common.movingAverage.args.inputColumnId.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L77"},"signature":["\"string\"[]"]},{"id":"def-common.movingAverage.args.inputColumnId.required","type":"boolean","label":"required","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L78"},"signature":["true"]}],"description":[],"label":"inputColumnId","source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L73"}},{"id":"def-common.movingAverage.args.outputColumnId","type":"Object","children":[{"id":"def-common.movingAverage.args.outputColumnId.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L81"}},{"id":"def-common.movingAverage.args.outputColumnId.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L84"},"signature":["\"string\"[]"]},{"id":"def-common.movingAverage.args.outputColumnId.required","type":"boolean","label":"required","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":85,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L85"},"signature":["true"]}],"description":[],"label":"outputColumnId","source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L80"}},{"id":"def-common.movingAverage.args.outputColumnName","type":"Object","children":[{"id":"def-common.movingAverage.args.outputColumnName.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L88"}},{"id":"def-common.movingAverage.args.outputColumnName.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":91,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L91"},"signature":["\"string\"[]"]},{"id":"def-common.movingAverage.args.outputColumnName.required","type":"boolean","label":"required","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L92"},"signature":["false"]}],"description":[],"label":"outputColumnName","source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":87,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L87"}},{"id":"def-common.movingAverage.args.window","type":"Object","children":[{"id":"def-common.movingAverage.args.window.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L95"}},{"id":"def-common.movingAverage.args.window.types","type":"Array","label":"types","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L98"},"signature":["\"number\"[]"]},{"id":"def-common.movingAverage.args.window.default","type":"number","label":"default","description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L99"}}],"description":[],"label":"window","source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L94"}}],"description":[],"label":"args","source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L64"}},{"id":"def-common.movingAverage.fn","type":"Function","label":"fn","signature":["(input: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"},", { by, inputColumnId, outputColumnId, outputColumnName, window }: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.MovingAverageArgs","text":"MovingAverageArgs"},") => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"}],"description":[],"children":[{"type":"Object","label":"input","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.Datatable","text":"Datatable"}],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L103"}},{"type":"Object","label":"{ by, inputColumnId, outputColumnId, outputColumnName, window }","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.MovingAverageArgs","text":"MovingAverageArgs"}],"description":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L103"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L103"}}],"description":["\nCalculates the moving average of a specified column in the data table.\n\nAlso supports multiple series in a single data table - use the `by` argument\nto specify the columns to split the calculation by.\nFor each unique combination of all `by` columns a separate moving average will be calculated.\nThe order of rows won't be changed - this function is not modifying any existing columns, it's only\nadding the specified `outputColumnId` column to every row of the table without adding or removing rows.\n\nBehavior:\n* Will write the moving average of `inputColumnId` into `outputColumnId`\n* If provided will use `outputColumnName` as name for the newly created column. Otherwise falls back to `outputColumnId`\n* Moving average always starts with an undefined value for the first row of a series. Each next cell will contain sum of the last\n* [window] of values divided by [window] excluding the current bucket.\nIf either of window edges moves outside the borders of data series, the window shrinks to include available values only.\n\nEdge cases:\n* Will return the input table if `inputColumnId` does not exist\n* Will throw an error if `outputColumnId` exists already in provided data table\n* If null or undefined value is encountered, skip the current row and do not change the window\n* For all values besides `null` and `undefined`, the value will be cast to a number before it's used in the\n calculation of the current series even if this results in `NaN` (like in case of objects).\n* To determine separate series defined by the `by` columns, the values of these columns will be cast to strings\n before comparison. If the values are objects, the return value of their `toString` method will be used for comparison."],"label":"movingAverage","source":{"path":"src/plugins/expressions/common/expression_functions/specs/moving_average.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/expression_functions/specs/moving_average.ts#L54"},"initialIsOpen":false},{"id":"def-common.defaultState","type":"Object","children":[{"id":"def-common.defaultState.functions","type":"Object","children":[],"description":[],"label":"functions","source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L23"}},{"id":"def-common.defaultState.types","type":"Object","children":[],"description":[],"label":"types","source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L24"}},{"id":"def-common.defaultState.context","type":"Object","children":[],"description":[],"label":"context","source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L25"}}],"description":[],"label":"defaultState","source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L22"},"initialIsOpen":false},{"id":"def-common.pureTransitions","type":"Object","children":[{"id":"def-common.pureTransitions.addFunction","type":"Function","children":[{"type":"Object","label":"state","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"},">"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L35"}}],"signature":["(state: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"},">) => (fn: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"},") => { functions: { [x: string]: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"},"; }; types: Record; context: Record; }"],"description":[],"label":"addFunction","source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L35"},"returnComment":[]},{"id":"def-common.pureTransitions.addType","type":"Function","children":[{"type":"Object","label":"state","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"},">"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L36"}}],"signature":["(state: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"},">) => (type: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionType","text":"ExpressionType"},") => { types: { [x: string]: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionType","text":"ExpressionType"},"; }; functions: Record; context: Record; }"],"description":[],"label":"addType","source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L36"},"returnComment":[]},{"id":"def-common.pureTransitions.extendContext","type":"Function","children":[{"type":"Object","label":"state","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"},">"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L37"}}],"signature":["(state: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"},">) => (extraContext: Record) => { context: { [x: string]: unknown; }; functions: Record; types: Record; }"],"description":[],"label":"extendContext","source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L37"},"returnComment":[]}],"description":[],"label":"pureTransitions","source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L34"},"initialIsOpen":false},{"id":"def-common.pureSelectors","type":"Object","children":[{"id":"def-common.pureSelectors.getFunction","type":"Function","children":[{"type":"Object","label":"state","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"},">"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L50"}}],"signature":["(state: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"},">) => (id: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionFunction","text":"ExpressionFunction"}],"description":[],"label":"getFunction","source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L50"},"returnComment":[]},{"id":"def-common.pureSelectors.getType","type":"Function","children":[{"type":"Object","label":"state","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"},">"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L51"}}],"signature":["(state: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"},">) => (id: string) => ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionType","text":"ExpressionType"}],"description":[],"label":"getType","source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L51"},"returnComment":[]},{"id":"def-common.pureSelectors.getContext","type":"Function","children":[{"type":"Object","label":"{ context }","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"},">"],"description":[],"source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L52"}}],"signature":["({ context }: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutorState","text":"ExecutorState"},">) => () => Record"],"description":[],"label":"getContext","source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L52"},"returnComment":[]}],"description":[],"label":"pureSelectors","source":{"path":"src/plugins/expressions/common/executor/container.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/executor/container.ts#L49"},"initialIsOpen":false},{"id":"def-common.executionPureTransitions","type":"Object","children":[{"id":"def-common.executionPureTransitions.start","type":"Function","children":[{"type":"Object","label":"state","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionState","text":"ExecutionState"},""],"description":[],"source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L57"}}],"signature":["(state: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionState","text":"ExecutionState"},") => () => { state: \"pending\"; ast: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},"; result?: any; error?: Error | undefined; functions: Record; types: Record; context: Record; }"],"description":[],"label":"start","source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L57"},"returnComment":[]},{"id":"def-common.executionPureTransitions.setResult","type":"Function","children":[{"type":"Object","label":"state","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionState","text":"ExecutionState"},""],"description":[],"source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L61"}}],"signature":["(state: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionState","text":"ExecutionState"},") => (result: any) => { state: \"result\"; result: any; ast: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},"; error?: Error | undefined; functions: Record; types: Record; context: Record; }"],"description":[],"label":"setResult","source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L61"},"returnComment":[]},{"id":"def-common.executionPureTransitions.setError","type":"Function","children":[{"type":"Object","label":"state","isRequired":true,"signature":[{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionState","text":"ExecutionState"},""],"description":[],"source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L66"}}],"signature":["(state: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExecutionState","text":"ExecutionState"},") => (error: Error) => { state: \"error\"; error: Error; ast: ",{"pluginId":"expressions","scope":"common","docId":"kibExpressionsPluginApi","section":"def-common.ExpressionAstExpression","text":"ExpressionAstExpression"},"; result?: any; functions: Record; types: Record; context: Record; }"],"description":[],"label":"setError","source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L66"},"returnComment":[]}],"description":[],"label":"executionPureTransitions","source":{"path":"src/plugins/expressions/common/execution/container.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/expressions/common/execution/container.ts#L56"},"initialIsOpen":false}]}} \ No newline at end of file diff --git a/api_docs/expressions.mdx b/api_docs/expressions.mdx new file mode 100644 index 0000000000000..1ba30191f15ea --- /dev/null +++ b/api_docs/expressions.mdx @@ -0,0 +1,58 @@ +--- +id: kibExpressionsPluginApi +slug: /kibana-dev-docs/expressionsPluginApi +title: expressions +image: https://source.unsplash.com/400x175/?github +summary: API docs for the expressions plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'expressions'] +--- + +import expressionsObj from './expressions.json'; + +## Client + +### Setup + +### Start + +### Functions + +### Classes + +### Interfaces + +### Enums + +### Consts, variables and types + +## Server + +### Setup + +### Start + +### Functions + +### Classes + +### Interfaces + +### Enums + +### Consts, variables and types + +## Common + +### Objects + +### Functions + +### Classes + +### Interfaces + +### Enums + +### Consts, variables and types + diff --git a/api_docs/features.json b/api_docs/features.json new file mode 100644 index 0000000000000..574bfaa66cdf9 --- /dev/null +++ b/api_docs/features.json @@ -0,0 +1 @@ +{"id":"features","client":{"classes":[{"id":"def-public.KibanaFeature","type":"Class","label":"KibanaFeature","description":[],"children":[{"id":"def-public.KibanaFeature.subFeatures","type":"Array","label":"subFeatures","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":138,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L138"},"signature":[{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.SubFeature","text":"SubFeature"},"[]"]},{"id":"def-public.KibanaFeature.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"config","isRequired":true,"signature":["Readonly<{ id: string; name: string; category: Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>; order?: number | undefined; excludeFromBasePrivileges?: boolean | undefined; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; app: readonly string[]; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: readonly string[] | undefined; privileges: Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null; subFeatures?: readonly Readonly<{ name: string; privilegeGroups: readonly Readonly<{ groupType: ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.SubFeaturePrivilegeGroupType","text":"SubFeaturePrivilegeGroupType"},"; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"read\" | \"all\" | \"none\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; ui: readonly string[]; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>"],"description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":140,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L140"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":140,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L140"}},{"id":"def-public.KibanaFeature.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":146,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L146"}},{"id":"def-public.KibanaFeature.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":150,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L150"}},{"id":"def-public.KibanaFeature.order","type":"number","label":"order","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":154,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L154"},"signature":["number | undefined"]},{"id":"def-public.KibanaFeature.category","type":"Object","label":"category","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":158,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L158"},"signature":["Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>"]},{"id":"def-public.KibanaFeature.app","type":"Object","label":"app","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":162,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L162"},"signature":["readonly string[]"]},{"id":"def-public.KibanaFeature.catalogue","type":"Object","label":"catalogue","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":166,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L166"},"signature":["readonly string[] | undefined"]},{"id":"def-public.KibanaFeature.management","type":"Object","label":"management","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":170,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L170"},"signature":["Readonly<{ [x: string]: readonly string[]; }> | undefined"]},{"id":"def-public.KibanaFeature.minimumLicense","type":"CompoundType","label":"minimumLicense","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":174,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L174"},"signature":["\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined"]},{"id":"def-public.KibanaFeature.privileges","type":"CompoundType","label":"privileges","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":178,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L178"},"signature":["Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null"]},{"id":"def-public.KibanaFeature.alerting","type":"Object","label":"alerting","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":182,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L182"},"signature":["readonly string[] | undefined"]},{"id":"def-public.KibanaFeature.excludeFromBasePrivileges","type":"boolean","label":"excludeFromBasePrivileges","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":186,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L186"}},{"id":"def-public.KibanaFeature.reserved","type":"Object","label":"reserved","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":190,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L190"},"signature":["Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined"]},{"id":"def-public.KibanaFeature.toRaw","type":"Function","label":"toRaw","signature":["() => ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.KibanaFeatureConfig","text":"KibanaFeatureConfig"}],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":194,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L194"}}],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":137,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L137"},"initialIsOpen":false}],"functions":[],"interfaces":[{"id":"def-public.KibanaFeatureConfig","type":"Interface","label":"KibanaFeatureConfig","description":["\nInterface for registering a feature.\nFeature registration allows plugins to hide their applications with spaces,\nand secure access when configured for security."],"children":[{"id":"def-public.KibanaFeatureConfig.id","type":"string","label":"id","description":["\nUnique identifier for this feature.\nThis identifier is also used when generating UI Capabilities.\n"],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L27"}},{"id":"def-public.KibanaFeatureConfig.name","type":"string","label":"name","description":["\nDisplay name for this feature.\nThis will be displayed to end-users, so a translatable string is advised for i18n."],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L33"}},{"id":"def-public.KibanaFeatureConfig.category","type":"Object","label":"category","description":["\nThe category for this feature.\nThis will be used to organize the list of features for display within the\nSpaces and Roles management screens."],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L40"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.AppCategory","text":"AppCategory"}]},{"id":"def-public.KibanaFeatureConfig.order","type":"number","label":"order","description":["\nAn ordinal used to sort features relative to one another for display."],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L45"},"signature":["number | undefined"]},{"id":"def-public.KibanaFeatureConfig.excludeFromBasePrivileges","type":"CompoundType","label":"excludeFromBasePrivileges","description":["\nWhether or not this feature should be excluded from the base privileges.\nThis is primarily helpful when migrating applications with a \"legacy\" privileges model\nto use Kibana privileges. We don't want these features to be considered part of the `all`\nor `read` base privileges in a minor release if the user was previously granted access\nusing an additional reserved role."],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L54"},"signature":["boolean | undefined"]},{"id":"def-public.KibanaFeatureConfig.minimumLicense","type":"CompoundType","label":"minimumLicense","description":["\nOptional minimum supported license.\nIf omitted, all licenses are allowed.\nThis does not restrict access to your feature based on license.\nIts only purpose is to inform the space and roles UIs on which features to display."],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L62"},"signature":["\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined"]},{"id":"def-public.KibanaFeatureConfig.app","type":"Object","label":"app","description":["\nAn array of app ids that are enabled when this feature is enabled.\nApps specified here will automatically cascade to the privileges defined below, unless specified differently there."],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L68"},"signature":["readonly string[]"]},{"id":"def-public.KibanaFeatureConfig.management","type":"Object","label":"management","description":["\nIf this feature includes management sections, you can specify them here to control visibility of those\npages based on the current space.\n\nItems specified here will automatically cascade to the privileges defined below, unless specified differently there.\n"],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L84"},"signature":["{ [sectionId: string]: readonly string[]; } | undefined"]},{"id":"def-public.KibanaFeatureConfig.catalogue","type":"Object","label":"catalogue","description":["\nIf this feature includes a catalogue entry, you can specify them here to control visibility based on the current space.\n\nItems specified here will automatically cascade to the privileges defined below, unless specified differently there."],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L92"},"signature":["readonly string[] | undefined"]},{"id":"def-public.KibanaFeatureConfig.alerting","type":"Object","label":"alerting","description":["\nIf your feature grants access to specific Alert Types, you can specify them here to control visibility based on the current space.\nInclude both Alert Types registered by the feature and external Alert Types such as built-in\nAlert Types and Alert Types provided by other features to which you wish to grant access."],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L99"},"signature":["readonly string[] | undefined"]},{"id":"def-public.KibanaFeatureConfig.privileges","type":"CompoundType","label":"privileges","description":["\nFeature privilege definition.\n"],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":113,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L113"},"signature":["{ all: ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.FeatureKibanaPrivileges","text":"FeatureKibanaPrivileges"},"; read: ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.FeatureKibanaPrivileges","text":"FeatureKibanaPrivileges"},"; } | null"]},{"id":"def-public.KibanaFeatureConfig.subFeatures","type":"Object","label":"subFeatures","description":["\nOptional sub-feature privilege definitions. This can only be specified if `privileges` are are also defined."],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":121,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L121"},"signature":["readonly ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.SubFeatureConfig","text":"SubFeatureConfig"},"[] | undefined"]},{"id":"def-public.KibanaFeatureConfig.privilegesTooltip","type":"string","label":"privilegesTooltip","description":["\nOptional message to display on the Role Management screen when configuring permissions for this feature."],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":126,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L126"},"signature":["string | undefined"]},{"id":"def-public.KibanaFeatureConfig.reserved","type":"Object","label":"reserved","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L131"},"signature":["{ description: string; privileges: readonly ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.ReservedKibanaPrivilege","text":"ReservedKibanaPrivilege"},"[]; } | undefined"]}],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L20"},"initialIsOpen":false},{"id":"def-public.FeatureKibanaPrivileges","type":"Interface","label":"FeatureKibanaPrivileges","description":["\nFeature privilege definition"],"children":[{"id":"def-public.FeatureKibanaPrivileges.excludeFromBasePrivileges","type":"CompoundType","label":"excludeFromBasePrivileges","description":["\nWhether or not this specific privilege should be excluded from the base privileges."],"source":{"path":"x-pack/plugins/features/common/feature_kibana_privileges.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L15"},"signature":["boolean | undefined"]},{"id":"def-public.FeatureKibanaPrivileges.management","type":"Object","label":"management","description":["\nIf this feature includes management sections, you can specify them here to control visibility of those\npages based on user privileges.\n"],"source":{"path":"x-pack/plugins/features/common/feature_kibana_privileges.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L29"},"signature":["{ [sectionId: string]: readonly string[]; } | undefined"]},{"id":"def-public.FeatureKibanaPrivileges.catalogue","type":"Object","label":"catalogue","description":["\nIf this feature includes a catalogue entry, you can specify them here to control visibility based on user permissions."],"source":{"path":"x-pack/plugins/features/common/feature_kibana_privileges.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L36"},"signature":["readonly string[] | undefined"]},{"id":"def-public.FeatureKibanaPrivileges.api","type":"Object","label":"api","description":["\nIf your feature includes server-side APIs, you can tag those routes to secure access based on user permissions.\n"],"source":{"path":"x-pack/plugins/features/common/feature_kibana_privileges.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L64"},"signature":["readonly string[] | undefined"]},{"id":"def-public.FeatureKibanaPrivileges.app","type":"Object","label":"app","description":["\nIf your feature exposes a client-side application (most of them do!), then you can control access to them here.\n"],"source":{"path":"x-pack/plugins/features/common/feature_kibana_privileges.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L77"},"signature":["readonly string[] | undefined"]},{"id":"def-public.FeatureKibanaPrivileges.alerting","type":"Object","label":"alerting","description":["\nIf your feature requires access to specific Alert Types, then specify your access needs here.\nInclude both Alert Types registered by the feature and external Alert Types such as built-in\nAlert Types and Alert Types provided by other features to which you wish to grant access."],"source":{"path":"x-pack/plugins/features/common/feature_kibana_privileges.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L84"},"signature":["{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; } | undefined"]},{"id":"def-public.FeatureKibanaPrivileges.savedObject","type":"Object","label":"savedObject","description":["\nIf your feature requires access to specific saved objects, then specify your access needs here."],"source":{"path":"x-pack/plugins/features/common/feature_kibana_privileges.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L110"},"signature":["{ all: readonly string[]; read: readonly string[]; }"]},{"id":"def-public.FeatureKibanaPrivileges.ui","type":"Object","label":"ui","description":["\nA list of UI Capabilities that should be granted to users with this privilege.\nThese capabilities will automatically be namespaces within your feature id.\n"],"source":{"path":"x-pack/plugins/features/common/feature_kibana_privileges.ts","lineNumber":153,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L153"},"signature":["readonly string[]"]}],"source":{"path":"x-pack/plugins/features/common/feature_kibana_privileges.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L11"},"initialIsOpen":false},{"id":"def-public.SubFeatureConfig","type":"Interface","label":"SubFeatureConfig","description":["\nConfiguration for a sub-feature."],"children":[{"id":"def-public.SubFeatureConfig.name","type":"string","label":"name","description":["Display name for this sub-feature"],"source":{"path":"x-pack/plugins/features/common/sub_feature.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L17"}},{"id":"def-public.SubFeatureConfig.privilegeGroups","type":"Object","label":"privilegeGroups","description":["Collection of privilege groups"],"source":{"path":"x-pack/plugins/features/common/sub_feature.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L20"},"signature":["readonly ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.SubFeaturePrivilegeGroupConfig","text":"SubFeaturePrivilegeGroupConfig"},"[]"]}],"source":{"path":"x-pack/plugins/features/common/sub_feature.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L15"},"initialIsOpen":false},{"id":"def-public.SubFeaturePrivilegeConfig","type":"Interface","label":"SubFeaturePrivilegeConfig","signature":[{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.SubFeaturePrivilegeConfig","text":"SubFeaturePrivilegeConfig"}," extends Pick<",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.FeatureKibanaPrivileges","text":"FeatureKibanaPrivileges"},", \"management\" | \"catalogue\" | \"ui\" | \"alerting\" | \"app\" | \"api\" | \"savedObject\">"],"description":["\nConfiguration for a sub-feature privilege."],"children":[{"id":"def-public.SubFeaturePrivilegeConfig.id","type":"string","label":"id","description":["\nIdentifier for this privilege. Must be unique across all other privileges within a feature."],"source":{"path":"x-pack/plugins/features/common/sub_feature.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L61"}},{"id":"def-public.SubFeaturePrivilegeConfig.name","type":"string","label":"name","description":["\nThe display name for this privilege."],"source":{"path":"x-pack/plugins/features/common/sub_feature.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L66"}},{"id":"def-public.SubFeaturePrivilegeConfig.includeIn","type":"CompoundType","label":"includeIn","description":["\nDenotes which Primary Feature Privilege this sub-feature privilege should be included in.\n`read` is also included in `all` automatically."],"source":{"path":"x-pack/plugins/features/common/sub_feature.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L72"},"signature":["\"read\" | \"all\" | \"none\""]},{"id":"def-public.SubFeaturePrivilegeConfig.minimumLicense","type":"CompoundType","label":"minimumLicense","description":["\nThe minimum supported license level for this sub-feature privilege.\nIf no license level is supplied, then this privilege will be available for all licences\nthat are valid for the overall feature."],"source":{"path":"x-pack/plugins/features/common/sub_feature.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L79"},"signature":["\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined"]}],"source":{"path":"x-pack/plugins/features/common/sub_feature.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L56"},"initialIsOpen":false}],"enums":[],"misc":[],"objects":[],"setup":{"id":"def-public.FeaturesPluginSetup","type":"Type","label":"FeaturesPluginSetup","description":[],"source":{"path":"x-pack/plugins/features/public/plugin.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/public/plugin.ts#L27"},"signature":["void"],"lifecycle":"setup","initialIsOpen":true},"start":{"id":"def-public.FeaturesPluginStart","type":"Type","label":"FeaturesPluginStart","description":[],"source":{"path":"x-pack/plugins/features/public/plugin.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/public/plugin.ts#L28"},"signature":["{ getFeatures: () => Promise<",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.KibanaFeature","text":"KibanaFeature"},"[]>; }"],"lifecycle":"start","initialIsOpen":true}},"server":{"classes":[{"id":"def-server.KibanaFeature","type":"Class","label":"KibanaFeature","description":[],"children":[{"id":"def-server.KibanaFeature.subFeatures","type":"Array","label":"subFeatures","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":138,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L138"},"signature":[{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.SubFeature","text":"SubFeature"},"[]"]},{"id":"def-server.KibanaFeature.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"config","isRequired":true,"signature":["Readonly<{ id: string; name: string; category: Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>; order?: number | undefined; excludeFromBasePrivileges?: boolean | undefined; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; app: readonly string[]; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: readonly string[] | undefined; privileges: Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null; subFeatures?: readonly Readonly<{ name: string; privilegeGroups: readonly Readonly<{ groupType: ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.SubFeaturePrivilegeGroupType","text":"SubFeaturePrivilegeGroupType"},"; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"read\" | \"all\" | \"none\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; ui: readonly string[]; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>"],"description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":140,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L140"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":140,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L140"}},{"id":"def-server.KibanaFeature.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":146,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L146"}},{"id":"def-server.KibanaFeature.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":150,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L150"}},{"id":"def-server.KibanaFeature.order","type":"number","label":"order","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":154,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L154"},"signature":["number | undefined"]},{"id":"def-server.KibanaFeature.category","type":"Object","label":"category","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":158,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L158"},"signature":["Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>"]},{"id":"def-server.KibanaFeature.app","type":"Object","label":"app","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":162,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L162"},"signature":["readonly string[]"]},{"id":"def-server.KibanaFeature.catalogue","type":"Object","label":"catalogue","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":166,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L166"},"signature":["readonly string[] | undefined"]},{"id":"def-server.KibanaFeature.management","type":"Object","label":"management","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":170,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L170"},"signature":["Readonly<{ [x: string]: readonly string[]; }> | undefined"]},{"id":"def-server.KibanaFeature.minimumLicense","type":"CompoundType","label":"minimumLicense","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":174,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L174"},"signature":["\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined"]},{"id":"def-server.KibanaFeature.privileges","type":"CompoundType","label":"privileges","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":178,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L178"},"signature":["Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null"]},{"id":"def-server.KibanaFeature.alerting","type":"Object","label":"alerting","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":182,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L182"},"signature":["readonly string[] | undefined"]},{"id":"def-server.KibanaFeature.excludeFromBasePrivileges","type":"boolean","label":"excludeFromBasePrivileges","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":186,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L186"}},{"id":"def-server.KibanaFeature.reserved","type":"Object","label":"reserved","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":190,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L190"},"signature":["Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined"]},{"id":"def-server.KibanaFeature.toRaw","type":"Function","label":"toRaw","signature":["() => ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.KibanaFeatureConfig","text":"KibanaFeatureConfig"}],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":194,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L194"}}],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":137,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L137"},"initialIsOpen":false},{"id":"def-server.ElasticsearchFeature","type":"Class","label":"ElasticsearchFeature","description":[],"children":[{"id":"def-server.ElasticsearchFeature.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"config","isRequired":true,"signature":["Readonly<{ id: string; management?: Readonly<{ [x: string]: ","RecursiveReadonlyArray","; }> | undefined; catalogue?: ","RecursiveReadonlyArray"," | undefined; privileges: ","RecursiveReadonlyArray","<",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.FeatureElasticsearchPrivileges","text":"FeatureElasticsearchPrivileges"},">; }>"],"description":[],"source":{"path":"x-pack/plugins/features/common/elasticsearch_feature.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L65"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/features/common/elasticsearch_feature.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L65"}},{"id":"def-server.ElasticsearchFeature.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/features/common/elasticsearch_feature.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L67"}},{"id":"def-server.ElasticsearchFeature.catalogue","type":"Object","label":"catalogue","description":[],"source":{"path":"x-pack/plugins/features/common/elasticsearch_feature.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L71"},"signature":["RecursiveReadonlyArray"," | undefined"]},{"id":"def-server.ElasticsearchFeature.management","type":"Object","label":"management","description":[],"source":{"path":"x-pack/plugins/features/common/elasticsearch_feature.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L75"},"signature":["Readonly<{ [x: string]: ","RecursiveReadonlyArray","; }> | undefined"]},{"id":"def-server.ElasticsearchFeature.privileges","type":"Object","label":"privileges","description":[],"source":{"path":"x-pack/plugins/features/common/elasticsearch_feature.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L79"},"signature":["RecursiveReadonlyArray","<",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.FeatureElasticsearchPrivileges","text":"FeatureElasticsearchPrivileges"},">"]},{"id":"def-server.ElasticsearchFeature.toRaw","type":"Function","label":"toRaw","signature":["() => ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.ElasticsearchFeatureConfig","text":"ElasticsearchFeatureConfig"}],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/features/common/elasticsearch_feature.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L83"}}],"source":{"path":"x-pack/plugins/features/common/elasticsearch_feature.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L64"},"initialIsOpen":false}],"functions":[],"interfaces":[{"id":"def-server.KibanaFeatureConfig","type":"Interface","label":"KibanaFeatureConfig","description":["\nInterface for registering a feature.\nFeature registration allows plugins to hide their applications with spaces,\nand secure access when configured for security."],"children":[{"id":"def-server.KibanaFeatureConfig.id","type":"string","label":"id","description":["\nUnique identifier for this feature.\nThis identifier is also used when generating UI Capabilities.\n"],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L27"}},{"id":"def-server.KibanaFeatureConfig.name","type":"string","label":"name","description":["\nDisplay name for this feature.\nThis will be displayed to end-users, so a translatable string is advised for i18n."],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L33"}},{"id":"def-server.KibanaFeatureConfig.category","type":"Object","label":"category","description":["\nThe category for this feature.\nThis will be used to organize the list of features for display within the\nSpaces and Roles management screens."],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L40"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.AppCategory","text":"AppCategory"}]},{"id":"def-server.KibanaFeatureConfig.order","type":"number","label":"order","description":["\nAn ordinal used to sort features relative to one another for display."],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L45"},"signature":["number | undefined"]},{"id":"def-server.KibanaFeatureConfig.excludeFromBasePrivileges","type":"CompoundType","label":"excludeFromBasePrivileges","description":["\nWhether or not this feature should be excluded from the base privileges.\nThis is primarily helpful when migrating applications with a \"legacy\" privileges model\nto use Kibana privileges. We don't want these features to be considered part of the `all`\nor `read` base privileges in a minor release if the user was previously granted access\nusing an additional reserved role."],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L54"},"signature":["boolean | undefined"]},{"id":"def-server.KibanaFeatureConfig.minimumLicense","type":"CompoundType","label":"minimumLicense","description":["\nOptional minimum supported license.\nIf omitted, all licenses are allowed.\nThis does not restrict access to your feature based on license.\nIts only purpose is to inform the space and roles UIs on which features to display."],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L62"},"signature":["\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined"]},{"id":"def-server.KibanaFeatureConfig.app","type":"Object","label":"app","description":["\nAn array of app ids that are enabled when this feature is enabled.\nApps specified here will automatically cascade to the privileges defined below, unless specified differently there."],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L68"},"signature":["readonly string[]"]},{"id":"def-server.KibanaFeatureConfig.management","type":"Object","label":"management","description":["\nIf this feature includes management sections, you can specify them here to control visibility of those\npages based on the current space.\n\nItems specified here will automatically cascade to the privileges defined below, unless specified differently there.\n"],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L84"},"signature":["{ [sectionId: string]: readonly string[]; } | undefined"]},{"id":"def-server.KibanaFeatureConfig.catalogue","type":"Object","label":"catalogue","description":["\nIf this feature includes a catalogue entry, you can specify them here to control visibility based on the current space.\n\nItems specified here will automatically cascade to the privileges defined below, unless specified differently there."],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L92"},"signature":["readonly string[] | undefined"]},{"id":"def-server.KibanaFeatureConfig.alerting","type":"Object","label":"alerting","description":["\nIf your feature grants access to specific Alert Types, you can specify them here to control visibility based on the current space.\nInclude both Alert Types registered by the feature and external Alert Types such as built-in\nAlert Types and Alert Types provided by other features to which you wish to grant access."],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L99"},"signature":["readonly string[] | undefined"]},{"id":"def-server.KibanaFeatureConfig.privileges","type":"CompoundType","label":"privileges","description":["\nFeature privilege definition.\n"],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":113,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L113"},"signature":["{ all: ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.FeatureKibanaPrivileges","text":"FeatureKibanaPrivileges"},"; read: ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.FeatureKibanaPrivileges","text":"FeatureKibanaPrivileges"},"; } | null"]},{"id":"def-server.KibanaFeatureConfig.subFeatures","type":"Object","label":"subFeatures","description":["\nOptional sub-feature privilege definitions. This can only be specified if `privileges` are are also defined."],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":121,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L121"},"signature":["readonly ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.SubFeatureConfig","text":"SubFeatureConfig"},"[] | undefined"]},{"id":"def-server.KibanaFeatureConfig.privilegesTooltip","type":"string","label":"privilegesTooltip","description":["\nOptional message to display on the Role Management screen when configuring permissions for this feature."],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":126,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L126"},"signature":["string | undefined"]},{"id":"def-server.KibanaFeatureConfig.reserved","type":"Object","label":"reserved","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L131"},"signature":["{ description: string; privileges: readonly ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.ReservedKibanaPrivilege","text":"ReservedKibanaPrivilege"},"[]; } | undefined"]}],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L20"},"initialIsOpen":false},{"id":"def-server.FeatureKibanaPrivileges","type":"Interface","label":"FeatureKibanaPrivileges","description":["\nFeature privilege definition"],"children":[{"id":"def-server.FeatureKibanaPrivileges.excludeFromBasePrivileges","type":"CompoundType","label":"excludeFromBasePrivileges","description":["\nWhether or not this specific privilege should be excluded from the base privileges."],"source":{"path":"x-pack/plugins/features/common/feature_kibana_privileges.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L15"},"signature":["boolean | undefined"]},{"id":"def-server.FeatureKibanaPrivileges.management","type":"Object","label":"management","description":["\nIf this feature includes management sections, you can specify them here to control visibility of those\npages based on user privileges.\n"],"source":{"path":"x-pack/plugins/features/common/feature_kibana_privileges.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L29"},"signature":["{ [sectionId: string]: readonly string[]; } | undefined"]},{"id":"def-server.FeatureKibanaPrivileges.catalogue","type":"Object","label":"catalogue","description":["\nIf this feature includes a catalogue entry, you can specify them here to control visibility based on user permissions."],"source":{"path":"x-pack/plugins/features/common/feature_kibana_privileges.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L36"},"signature":["readonly string[] | undefined"]},{"id":"def-server.FeatureKibanaPrivileges.api","type":"Object","label":"api","description":["\nIf your feature includes server-side APIs, you can tag those routes to secure access based on user permissions.\n"],"source":{"path":"x-pack/plugins/features/common/feature_kibana_privileges.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L64"},"signature":["readonly string[] | undefined"]},{"id":"def-server.FeatureKibanaPrivileges.app","type":"Object","label":"app","description":["\nIf your feature exposes a client-side application (most of them do!), then you can control access to them here.\n"],"source":{"path":"x-pack/plugins/features/common/feature_kibana_privileges.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L77"},"signature":["readonly string[] | undefined"]},{"id":"def-server.FeatureKibanaPrivileges.alerting","type":"Object","label":"alerting","description":["\nIf your feature requires access to specific Alert Types, then specify your access needs here.\nInclude both Alert Types registered by the feature and external Alert Types such as built-in\nAlert Types and Alert Types provided by other features to which you wish to grant access."],"source":{"path":"x-pack/plugins/features/common/feature_kibana_privileges.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L84"},"signature":["{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; } | undefined"]},{"id":"def-server.FeatureKibanaPrivileges.savedObject","type":"Object","label":"savedObject","description":["\nIf your feature requires access to specific saved objects, then specify your access needs here."],"source":{"path":"x-pack/plugins/features/common/feature_kibana_privileges.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L110"},"signature":["{ all: readonly string[]; read: readonly string[]; }"]},{"id":"def-server.FeatureKibanaPrivileges.ui","type":"Object","label":"ui","description":["\nA list of UI Capabilities that should be granted to users with this privilege.\nThese capabilities will automatically be namespaces within your feature id.\n"],"source":{"path":"x-pack/plugins/features/common/feature_kibana_privileges.ts","lineNumber":153,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L153"},"signature":["readonly string[]"]}],"source":{"path":"x-pack/plugins/features/common/feature_kibana_privileges.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L11"},"initialIsOpen":false},{"id":"def-server.ElasticsearchFeatureConfig","type":"Interface","label":"ElasticsearchFeatureConfig","description":["\nInterface for registering an Elasticsearch feature.\nFeature registration allows plugins to hide their applications based\non configured cluster or index privileges."],"children":[{"id":"def-server.ElasticsearchFeatureConfig.id","type":"string","label":"id","description":["\nUnique identifier for this feature.\nThis identifier is also used when generating UI Capabilities.\n"],"source":{"path":"x-pack/plugins/features/common/elasticsearch_feature.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L23"}},{"id":"def-server.ElasticsearchFeatureConfig.management","type":"Object","label":"management","description":["\nManagement sections associated with this feature.\n"],"source":{"path":"x-pack/plugins/features/common/elasticsearch_feature.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L36"},"signature":["{ [sectionId: string]: string[]; } | undefined"]},{"id":"def-server.ElasticsearchFeatureConfig.catalogue","type":"Array","label":"catalogue","description":["\nIf this feature includes a catalogue entry, you can specify them here to control visibility based on the current space.\n"],"source":{"path":"x-pack/plugins/features/common/elasticsearch_feature.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L44"},"signature":["string[] | undefined"]},{"id":"def-server.ElasticsearchFeatureConfig.privileges","type":"Array","label":"privileges","description":["\nFeature privilege definition. Specify one or more privileges which grant access to this feature.\nUsers must satisfy all privileges in at least one of the defined sets of privileges in order to be granted access.\n"],"source":{"path":"x-pack/plugins/features/common/elasticsearch_feature.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L61"},"signature":[{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.FeatureElasticsearchPrivileges","text":"FeatureElasticsearchPrivileges"},"[]"]}],"source":{"path":"x-pack/plugins/features/common/elasticsearch_feature.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L16"},"initialIsOpen":false},{"id":"def-server.FeatureElasticsearchPrivileges","type":"Interface","label":"FeatureElasticsearchPrivileges","description":["\nElasticsearch Feature privilege definition"],"children":[{"id":"def-server.FeatureElasticsearchPrivileges.requiredClusterPrivileges","type":"Array","label":"requiredClusterPrivileges","description":["\nA set of Elasticsearch cluster privileges which are required for this feature to be enabled.\nSee https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html\n"],"source":{"path":"x-pack/plugins/features/common/feature_elasticsearch_privileges.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_elasticsearch_privileges.ts#L17"},"signature":["string[]"]},{"id":"def-server.FeatureElasticsearchPrivileges.requiredIndexPrivileges","type":"Object","label":"requiredIndexPrivileges","description":["\nA set of Elasticsearch index privileges which are required for this feature to be enabled, keyed on index name or pattern.\nSee https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html#privileges-list-indices\n"],"source":{"path":"x-pack/plugins/features/common/feature_elasticsearch_privileges.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_elasticsearch_privileges.ts#L38"},"signature":["{ [indexName: string]: string[]; } | undefined"]},{"id":"def-server.FeatureElasticsearchPrivileges.requiredRoles","type":"Array","label":"requiredRoles","description":["\nA set of Elasticsearch roles which are required for this feature to be enabled.\n"],"source":{"path":"x-pack/plugins/features/common/feature_elasticsearch_privileges.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_elasticsearch_privileges.ts#L50"},"signature":["string[] | undefined"]},{"id":"def-server.FeatureElasticsearchPrivileges.ui","type":"Array","label":"ui","description":["\nA list of UI Capabilities that should be granted to users with this privilege.\nThese capabilities will automatically be namespaces within your feature id.\n"],"source":{"path":"x-pack/plugins/features/common/feature_elasticsearch_privileges.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_elasticsearch_privileges.ts#L72"},"signature":["string[]"]}],"source":{"path":"x-pack/plugins/features/common/feature_elasticsearch_privileges.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_elasticsearch_privileges.ts#L11"},"initialIsOpen":false},{"id":"def-server.PluginSetupContract","type":"Interface","label":"PluginSetupContract","description":["\nDescribes public Features plugin contract returned at the `setup` stage."],"children":[{"id":"def-server.PluginSetupContract.registerKibanaFeature","type":"Function","label":"registerKibanaFeature","signature":["(feature: ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.KibanaFeatureConfig","text":"KibanaFeatureConfig"},") => void"],"description":[],"children":[{"type":"Object","label":"feature","isRequired":true,"signature":[{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.KibanaFeatureConfig","text":"KibanaFeatureConfig"}],"description":[],"source":{"path":"x-pack/plugins/features/server/plugin.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/server/plugin.ts#L34"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/features/server/plugin.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/server/plugin.ts#L34"}},{"id":"def-server.PluginSetupContract.registerElasticsearchFeature","type":"Function","label":"registerElasticsearchFeature","signature":["(feature: ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.ElasticsearchFeatureConfig","text":"ElasticsearchFeatureConfig"},") => void"],"description":[],"children":[{"type":"Object","label":"feature","isRequired":true,"signature":[{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.ElasticsearchFeatureConfig","text":"ElasticsearchFeatureConfig"}],"description":[],"source":{"path":"x-pack/plugins/features/server/plugin.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/server/plugin.ts#L35"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/features/server/plugin.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/server/plugin.ts#L35"}},{"id":"def-server.PluginSetupContract.getKibanaFeatures","type":"Function","label":"getKibanaFeatures","signature":["() => ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.KibanaFeature","text":"KibanaFeature"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/features/server/plugin.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/server/plugin.ts#L41"}},{"id":"def-server.PluginSetupContract.getElasticsearchFeatures","type":"Function","label":"getElasticsearchFeatures","signature":["() => ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.ElasticsearchFeature","text":"ElasticsearchFeature"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/features/server/plugin.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/server/plugin.ts#L47"}},{"id":"def-server.PluginSetupContract.getFeaturesUICapabilities","type":"Function","label":"getFeaturesUICapabilities","signature":["() => ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.Capabilities","text":"Capabilities"}],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/features/server/plugin.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/server/plugin.ts#L48"}}],"source":{"path":"x-pack/plugins/features/server/plugin.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/server/plugin.ts#L33"},"initialIsOpen":false},{"id":"def-server.PluginStartContract","type":"Interface","label":"PluginStartContract","description":[],"children":[{"id":"def-server.PluginStartContract.getElasticsearchFeatures","type":"Function","label":"getElasticsearchFeatures","signature":["() => ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.ElasticsearchFeature","text":"ElasticsearchFeature"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/features/server/plugin.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/server/plugin.ts#L52"}},{"id":"def-server.PluginStartContract.getKibanaFeatures","type":"Function","label":"getKibanaFeatures","signature":["() => ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.KibanaFeature","text":"KibanaFeature"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/features/server/plugin.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/server/plugin.ts#L53"}}],"source":{"path":"x-pack/plugins/features/server/plugin.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/server/plugin.ts#L51"},"initialIsOpen":false}],"enums":[],"misc":[],"objects":[{"id":"def-server.uiCapabilitiesRegex","type":"Object","label":"uiCapabilitiesRegex","description":[],"source":{"path":"x-pack/plugins/features/server/feature_schema.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/server/feature_schema.ts#L23"},"signature":["RegExp"],"initialIsOpen":false}]},"common":{"classes":[{"id":"def-common.ElasticsearchFeature","type":"Class","label":"ElasticsearchFeature","description":[],"children":[{"id":"def-common.ElasticsearchFeature.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"config","isRequired":true,"signature":["Readonly<{ id: string; management?: Readonly<{ [x: string]: ","RecursiveReadonlyArray","; }> | undefined; catalogue?: ","RecursiveReadonlyArray"," | undefined; privileges: ","RecursiveReadonlyArray","<",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.FeatureElasticsearchPrivileges","text":"FeatureElasticsearchPrivileges"},">; }>"],"description":[],"source":{"path":"x-pack/plugins/features/common/elasticsearch_feature.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L65"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/features/common/elasticsearch_feature.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L65"}},{"id":"def-common.ElasticsearchFeature.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/features/common/elasticsearch_feature.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L67"}},{"id":"def-common.ElasticsearchFeature.catalogue","type":"Object","label":"catalogue","description":[],"source":{"path":"x-pack/plugins/features/common/elasticsearch_feature.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L71"},"signature":["RecursiveReadonlyArray"," | undefined"]},{"id":"def-common.ElasticsearchFeature.management","type":"Object","label":"management","description":[],"source":{"path":"x-pack/plugins/features/common/elasticsearch_feature.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L75"},"signature":["Readonly<{ [x: string]: ","RecursiveReadonlyArray","; }> | undefined"]},{"id":"def-common.ElasticsearchFeature.privileges","type":"Object","label":"privileges","description":[],"source":{"path":"x-pack/plugins/features/common/elasticsearch_feature.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L79"},"signature":["RecursiveReadonlyArray","<",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.FeatureElasticsearchPrivileges","text":"FeatureElasticsearchPrivileges"},">"]},{"id":"def-common.ElasticsearchFeature.toRaw","type":"Function","label":"toRaw","signature":["() => ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.ElasticsearchFeatureConfig","text":"ElasticsearchFeatureConfig"}],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/features/common/elasticsearch_feature.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L83"}}],"source":{"path":"x-pack/plugins/features/common/elasticsearch_feature.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L64"},"initialIsOpen":false},{"id":"def-common.KibanaFeature","type":"Class","label":"KibanaFeature","description":[],"children":[{"id":"def-common.KibanaFeature.subFeatures","type":"Array","label":"subFeatures","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":138,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L138"},"signature":[{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.SubFeature","text":"SubFeature"},"[]"]},{"id":"def-common.KibanaFeature.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"config","isRequired":true,"signature":["Readonly<{ id: string; name: string; category: Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>; order?: number | undefined; excludeFromBasePrivileges?: boolean | undefined; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; app: readonly string[]; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; alerting?: readonly string[] | undefined; privileges: Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null; subFeatures?: readonly Readonly<{ name: string; privilegeGroups: readonly Readonly<{ groupType: ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.SubFeaturePrivilegeGroupType","text":"SubFeaturePrivilegeGroupType"},"; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"read\" | \"all\" | \"none\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; ui: readonly string[]; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>[] | undefined; privilegesTooltip?: string | undefined; reserved?: Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined; }>"],"description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":140,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L140"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":140,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L140"}},{"id":"def-common.KibanaFeature.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":146,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L146"}},{"id":"def-common.KibanaFeature.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":150,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L150"}},{"id":"def-common.KibanaFeature.order","type":"number","label":"order","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":154,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L154"},"signature":["number | undefined"]},{"id":"def-common.KibanaFeature.category","type":"Object","label":"category","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":158,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L158"},"signature":["Readonly<{ id: string; label: string; ariaLabel?: string | undefined; order?: number | undefined; euiIconType?: string | undefined; }>"]},{"id":"def-common.KibanaFeature.app","type":"Object","label":"app","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":162,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L162"},"signature":["readonly string[]"]},{"id":"def-common.KibanaFeature.catalogue","type":"Object","label":"catalogue","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":166,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L166"},"signature":["readonly string[] | undefined"]},{"id":"def-common.KibanaFeature.management","type":"Object","label":"management","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":170,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L170"},"signature":["Readonly<{ [x: string]: readonly string[]; }> | undefined"]},{"id":"def-common.KibanaFeature.minimumLicense","type":"CompoundType","label":"minimumLicense","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":174,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L174"},"signature":["\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined"]},{"id":"def-common.KibanaFeature.privileges","type":"CompoundType","label":"privileges","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":178,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L178"},"signature":["Readonly<{ all: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; read: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }> | null"]},{"id":"def-common.KibanaFeature.alerting","type":"Object","label":"alerting","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":182,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L182"},"signature":["readonly string[] | undefined"]},{"id":"def-common.KibanaFeature.excludeFromBasePrivileges","type":"boolean","label":"excludeFromBasePrivileges","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":186,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L186"}},{"id":"def-common.KibanaFeature.reserved","type":"Object","label":"reserved","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":190,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L190"},"signature":["Readonly<{ description: string; privileges: readonly Readonly<{ id: string; privilege: Readonly<{ excludeFromBasePrivileges?: boolean | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; api?: readonly string[] | undefined; app?: readonly string[] | undefined; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; ui: readonly string[]; }>; }>[]; }> | undefined"]},{"id":"def-common.KibanaFeature.toRaw","type":"Function","label":"toRaw","signature":["() => ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.KibanaFeatureConfig","text":"KibanaFeatureConfig"}],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":194,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L194"}}],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":137,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L137"},"initialIsOpen":false},{"id":"def-common.SubFeature","type":"Class","label":"SubFeature","description":[],"children":[{"id":"def-common.SubFeature.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"config","isRequired":true,"signature":["Readonly<{ name: string; privilegeGroups: readonly Readonly<{ groupType: ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.SubFeaturePrivilegeGroupType","text":"SubFeaturePrivilegeGroupType"},"; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"read\" | \"all\" | \"none\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; ui: readonly string[]; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }>"],"description":[],"source":{"path":"x-pack/plugins/features/common/sub_feature.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L83"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/features/common/sub_feature.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L83"}},{"id":"def-common.SubFeature.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/features/common/sub_feature.ts","lineNumber":85,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L85"}},{"id":"def-common.SubFeature.privilegeGroups","type":"Object","label":"privilegeGroups","description":[],"source":{"path":"x-pack/plugins/features/common/sub_feature.ts","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L89"},"signature":["readonly Readonly<{ groupType: ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.SubFeaturePrivilegeGroupType","text":"SubFeaturePrivilegeGroupType"},"; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"read\" | \"all\" | \"none\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; ui: readonly string[]; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]"]},{"id":"def-common.SubFeature.toRaw","type":"Function","label":"toRaw","signature":["() => { name: string; privilegeGroups: readonly Readonly<{ groupType: ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.SubFeaturePrivilegeGroupType","text":"SubFeaturePrivilegeGroupType"},"; privileges: readonly Readonly<{ id: string; name: string; includeIn: \"read\" | \"all\" | \"none\"; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; management?: Readonly<{ [x: string]: readonly string[]; }> | undefined; catalogue?: readonly string[] | undefined; ui: readonly string[]; alerting?: Readonly<{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; }> | undefined; app?: readonly string[] | undefined; api?: readonly string[] | undefined; savedObject: Readonly<{ all: readonly string[]; read: readonly string[]; }>; }>[]; }>[]; }"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/features/common/sub_feature.ts","lineNumber":93,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L93"}}],"source":{"path":"x-pack/plugins/features/common/sub_feature.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L82"},"initialIsOpen":false}],"functions":[],"interfaces":[{"id":"def-common.FeatureElasticsearchPrivileges","type":"Interface","label":"FeatureElasticsearchPrivileges","description":["\nElasticsearch Feature privilege definition"],"children":[{"id":"def-common.FeatureElasticsearchPrivileges.requiredClusterPrivileges","type":"Array","label":"requiredClusterPrivileges","description":["\nA set of Elasticsearch cluster privileges which are required for this feature to be enabled.\nSee https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html\n"],"source":{"path":"x-pack/plugins/features/common/feature_elasticsearch_privileges.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_elasticsearch_privileges.ts#L17"},"signature":["string[]"]},{"id":"def-common.FeatureElasticsearchPrivileges.requiredIndexPrivileges","type":"Object","label":"requiredIndexPrivileges","description":["\nA set of Elasticsearch index privileges which are required for this feature to be enabled, keyed on index name or pattern.\nSee https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html#privileges-list-indices\n"],"source":{"path":"x-pack/plugins/features/common/feature_elasticsearch_privileges.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_elasticsearch_privileges.ts#L38"},"signature":["{ [indexName: string]: string[]; } | undefined"]},{"id":"def-common.FeatureElasticsearchPrivileges.requiredRoles","type":"Array","label":"requiredRoles","description":["\nA set of Elasticsearch roles which are required for this feature to be enabled.\n"],"source":{"path":"x-pack/plugins/features/common/feature_elasticsearch_privileges.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_elasticsearch_privileges.ts#L50"},"signature":["string[] | undefined"]},{"id":"def-common.FeatureElasticsearchPrivileges.ui","type":"Array","label":"ui","description":["\nA list of UI Capabilities that should be granted to users with this privilege.\nThese capabilities will automatically be namespaces within your feature id.\n"],"source":{"path":"x-pack/plugins/features/common/feature_elasticsearch_privileges.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_elasticsearch_privileges.ts#L72"},"signature":["string[]"]}],"source":{"path":"x-pack/plugins/features/common/feature_elasticsearch_privileges.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_elasticsearch_privileges.ts#L11"},"initialIsOpen":false},{"id":"def-common.FeatureKibanaPrivileges","type":"Interface","label":"FeatureKibanaPrivileges","description":["\nFeature privilege definition"],"children":[{"id":"def-common.FeatureKibanaPrivileges.excludeFromBasePrivileges","type":"CompoundType","label":"excludeFromBasePrivileges","description":["\nWhether or not this specific privilege should be excluded from the base privileges."],"source":{"path":"x-pack/plugins/features/common/feature_kibana_privileges.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L15"},"signature":["boolean | undefined"]},{"id":"def-common.FeatureKibanaPrivileges.management","type":"Object","label":"management","description":["\nIf this feature includes management sections, you can specify them here to control visibility of those\npages based on user privileges.\n"],"source":{"path":"x-pack/plugins/features/common/feature_kibana_privileges.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L29"},"signature":["{ [sectionId: string]: readonly string[]; } | undefined"]},{"id":"def-common.FeatureKibanaPrivileges.catalogue","type":"Object","label":"catalogue","description":["\nIf this feature includes a catalogue entry, you can specify them here to control visibility based on user permissions."],"source":{"path":"x-pack/plugins/features/common/feature_kibana_privileges.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L36"},"signature":["readonly string[] | undefined"]},{"id":"def-common.FeatureKibanaPrivileges.api","type":"Object","label":"api","description":["\nIf your feature includes server-side APIs, you can tag those routes to secure access based on user permissions.\n"],"source":{"path":"x-pack/plugins/features/common/feature_kibana_privileges.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L64"},"signature":["readonly string[] | undefined"]},{"id":"def-common.FeatureKibanaPrivileges.app","type":"Object","label":"app","description":["\nIf your feature exposes a client-side application (most of them do!), then you can control access to them here.\n"],"source":{"path":"x-pack/plugins/features/common/feature_kibana_privileges.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L77"},"signature":["readonly string[] | undefined"]},{"id":"def-common.FeatureKibanaPrivileges.alerting","type":"Object","label":"alerting","description":["\nIf your feature requires access to specific Alert Types, then specify your access needs here.\nInclude both Alert Types registered by the feature and external Alert Types such as built-in\nAlert Types and Alert Types provided by other features to which you wish to grant access."],"source":{"path":"x-pack/plugins/features/common/feature_kibana_privileges.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L84"},"signature":["{ all?: readonly string[] | undefined; read?: readonly string[] | undefined; } | undefined"]},{"id":"def-common.FeatureKibanaPrivileges.savedObject","type":"Object","label":"savedObject","description":["\nIf your feature requires access to specific saved objects, then specify your access needs here."],"source":{"path":"x-pack/plugins/features/common/feature_kibana_privileges.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L110"},"signature":["{ all: readonly string[]; read: readonly string[]; }"]},{"id":"def-common.FeatureKibanaPrivileges.ui","type":"Object","label":"ui","description":["\nA list of UI Capabilities that should be granted to users with this privilege.\nThese capabilities will automatically be namespaces within your feature id.\n"],"source":{"path":"x-pack/plugins/features/common/feature_kibana_privileges.ts","lineNumber":153,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L153"},"signature":["readonly string[]"]}],"source":{"path":"x-pack/plugins/features/common/feature_kibana_privileges.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/feature_kibana_privileges.ts#L11"},"initialIsOpen":false},{"id":"def-common.ElasticsearchFeatureConfig","type":"Interface","label":"ElasticsearchFeatureConfig","description":["\nInterface for registering an Elasticsearch feature.\nFeature registration allows plugins to hide their applications based\non configured cluster or index privileges."],"children":[{"id":"def-common.ElasticsearchFeatureConfig.id","type":"string","label":"id","description":["\nUnique identifier for this feature.\nThis identifier is also used when generating UI Capabilities.\n"],"source":{"path":"x-pack/plugins/features/common/elasticsearch_feature.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L23"}},{"id":"def-common.ElasticsearchFeatureConfig.management","type":"Object","label":"management","description":["\nManagement sections associated with this feature.\n"],"source":{"path":"x-pack/plugins/features/common/elasticsearch_feature.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L36"},"signature":["{ [sectionId: string]: string[]; } | undefined"]},{"id":"def-common.ElasticsearchFeatureConfig.catalogue","type":"Array","label":"catalogue","description":["\nIf this feature includes a catalogue entry, you can specify them here to control visibility based on the current space.\n"],"source":{"path":"x-pack/plugins/features/common/elasticsearch_feature.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L44"},"signature":["string[] | undefined"]},{"id":"def-common.ElasticsearchFeatureConfig.privileges","type":"Array","label":"privileges","description":["\nFeature privilege definition. Specify one or more privileges which grant access to this feature.\nUsers must satisfy all privileges in at least one of the defined sets of privileges in order to be granted access.\n"],"source":{"path":"x-pack/plugins/features/common/elasticsearch_feature.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L61"},"signature":[{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.FeatureElasticsearchPrivileges","text":"FeatureElasticsearchPrivileges"},"[]"]}],"source":{"path":"x-pack/plugins/features/common/elasticsearch_feature.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/elasticsearch_feature.ts#L16"},"initialIsOpen":false},{"id":"def-common.KibanaFeatureConfig","type":"Interface","label":"KibanaFeatureConfig","description":["\nInterface for registering a feature.\nFeature registration allows plugins to hide their applications with spaces,\nand secure access when configured for security."],"children":[{"id":"def-common.KibanaFeatureConfig.id","type":"string","label":"id","description":["\nUnique identifier for this feature.\nThis identifier is also used when generating UI Capabilities.\n"],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L27"}},{"id":"def-common.KibanaFeatureConfig.name","type":"string","label":"name","description":["\nDisplay name for this feature.\nThis will be displayed to end-users, so a translatable string is advised for i18n."],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L33"}},{"id":"def-common.KibanaFeatureConfig.category","type":"Object","label":"category","description":["\nThe category for this feature.\nThis will be used to organize the list of features for display within the\nSpaces and Roles management screens."],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L40"},"signature":[{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.AppCategory","text":"AppCategory"}]},{"id":"def-common.KibanaFeatureConfig.order","type":"number","label":"order","description":["\nAn ordinal used to sort features relative to one another for display."],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L45"},"signature":["number | undefined"]},{"id":"def-common.KibanaFeatureConfig.excludeFromBasePrivileges","type":"CompoundType","label":"excludeFromBasePrivileges","description":["\nWhether or not this feature should be excluded from the base privileges.\nThis is primarily helpful when migrating applications with a \"legacy\" privileges model\nto use Kibana privileges. We don't want these features to be considered part of the `all`\nor `read` base privileges in a minor release if the user was previously granted access\nusing an additional reserved role."],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L54"},"signature":["boolean | undefined"]},{"id":"def-common.KibanaFeatureConfig.minimumLicense","type":"CompoundType","label":"minimumLicense","description":["\nOptional minimum supported license.\nIf omitted, all licenses are allowed.\nThis does not restrict access to your feature based on license.\nIts only purpose is to inform the space and roles UIs on which features to display."],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L62"},"signature":["\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined"]},{"id":"def-common.KibanaFeatureConfig.app","type":"Object","label":"app","description":["\nAn array of app ids that are enabled when this feature is enabled.\nApps specified here will automatically cascade to the privileges defined below, unless specified differently there."],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L68"},"signature":["readonly string[]"]},{"id":"def-common.KibanaFeatureConfig.management","type":"Object","label":"management","description":["\nIf this feature includes management sections, you can specify them here to control visibility of those\npages based on the current space.\n\nItems specified here will automatically cascade to the privileges defined below, unless specified differently there.\n"],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L84"},"signature":["{ [sectionId: string]: readonly string[]; } | undefined"]},{"id":"def-common.KibanaFeatureConfig.catalogue","type":"Object","label":"catalogue","description":["\nIf this feature includes a catalogue entry, you can specify them here to control visibility based on the current space.\n\nItems specified here will automatically cascade to the privileges defined below, unless specified differently there."],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L92"},"signature":["readonly string[] | undefined"]},{"id":"def-common.KibanaFeatureConfig.alerting","type":"Object","label":"alerting","description":["\nIf your feature grants access to specific Alert Types, you can specify them here to control visibility based on the current space.\nInclude both Alert Types registered by the feature and external Alert Types such as built-in\nAlert Types and Alert Types provided by other features to which you wish to grant access."],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L99"},"signature":["readonly string[] | undefined"]},{"id":"def-common.KibanaFeatureConfig.privileges","type":"CompoundType","label":"privileges","description":["\nFeature privilege definition.\n"],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":113,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L113"},"signature":["{ all: ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.FeatureKibanaPrivileges","text":"FeatureKibanaPrivileges"},"; read: ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.FeatureKibanaPrivileges","text":"FeatureKibanaPrivileges"},"; } | null"]},{"id":"def-common.KibanaFeatureConfig.subFeatures","type":"Object","label":"subFeatures","description":["\nOptional sub-feature privilege definitions. This can only be specified if `privileges` are are also defined."],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":121,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L121"},"signature":["readonly ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.SubFeatureConfig","text":"SubFeatureConfig"},"[] | undefined"]},{"id":"def-common.KibanaFeatureConfig.privilegesTooltip","type":"string","label":"privilegesTooltip","description":["\nOptional message to display on the Role Management screen when configuring permissions for this feature."],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":126,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L126"},"signature":["string | undefined"]},{"id":"def-common.KibanaFeatureConfig.reserved","type":"Object","label":"reserved","description":[],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L131"},"signature":["{ description: string; privileges: readonly ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.ReservedKibanaPrivilege","text":"ReservedKibanaPrivilege"},"[]; } | undefined"]}],"source":{"path":"x-pack/plugins/features/common/kibana_feature.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/kibana_feature.ts#L20"},"initialIsOpen":false},{"id":"def-common.SubFeatureConfig","type":"Interface","label":"SubFeatureConfig","description":["\nConfiguration for a sub-feature."],"children":[{"id":"def-common.SubFeatureConfig.name","type":"string","label":"name","description":["Display name for this sub-feature"],"source":{"path":"x-pack/plugins/features/common/sub_feature.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L17"}},{"id":"def-common.SubFeatureConfig.privilegeGroups","type":"Object","label":"privilegeGroups","description":["Collection of privilege groups"],"source":{"path":"x-pack/plugins/features/common/sub_feature.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L20"},"signature":["readonly ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.SubFeaturePrivilegeGroupConfig","text":"SubFeaturePrivilegeGroupConfig"},"[]"]}],"source":{"path":"x-pack/plugins/features/common/sub_feature.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L15"},"initialIsOpen":false},{"id":"def-common.SubFeaturePrivilegeConfig","type":"Interface","label":"SubFeaturePrivilegeConfig","signature":[{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.SubFeaturePrivilegeConfig","text":"SubFeaturePrivilegeConfig"}," extends Pick<",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.FeatureKibanaPrivileges","text":"FeatureKibanaPrivileges"},", \"management\" | \"catalogue\" | \"ui\" | \"alerting\" | \"app\" | \"api\" | \"savedObject\">"],"description":["\nConfiguration for a sub-feature privilege."],"children":[{"id":"def-common.SubFeaturePrivilegeConfig.id","type":"string","label":"id","description":["\nIdentifier for this privilege. Must be unique across all other privileges within a feature."],"source":{"path":"x-pack/plugins/features/common/sub_feature.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L61"}},{"id":"def-common.SubFeaturePrivilegeConfig.name","type":"string","label":"name","description":["\nThe display name for this privilege."],"source":{"path":"x-pack/plugins/features/common/sub_feature.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L66"}},{"id":"def-common.SubFeaturePrivilegeConfig.includeIn","type":"CompoundType","label":"includeIn","description":["\nDenotes which Primary Feature Privilege this sub-feature privilege should be included in.\n`read` is also included in `all` automatically."],"source":{"path":"x-pack/plugins/features/common/sub_feature.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L72"},"signature":["\"read\" | \"all\" | \"none\""]},{"id":"def-common.SubFeaturePrivilegeConfig.minimumLicense","type":"CompoundType","label":"minimumLicense","description":["\nThe minimum supported license level for this sub-feature privilege.\nIf no license level is supplied, then this privilege will be available for all licences\nthat are valid for the overall feature."],"source":{"path":"x-pack/plugins/features/common/sub_feature.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L79"},"signature":["\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined"]}],"source":{"path":"x-pack/plugins/features/common/sub_feature.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L56"},"initialIsOpen":false},{"id":"def-common.SubFeaturePrivilegeGroupConfig","type":"Interface","label":"SubFeaturePrivilegeGroupConfig","description":["\nConfiguration for a sub-feature privilege group."],"children":[{"id":"def-common.SubFeaturePrivilegeGroupConfig.groupType","type":"CompoundType","label":"groupType","description":["\nThe type of privilege group.\n- `mutually_exclusive`::\n Users will be able to select at most one privilege within this group.\n Privileges must be specified in descending order of permissiveness (e.g. `All`, `Read`, not `Read`, `All)\n- `independent`::\n Users will be able to select any combination of privileges within this group."],"source":{"path":"x-pack/plugins/features/common/sub_feature.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L45"},"signature":[{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.SubFeaturePrivilegeGroupType","text":"SubFeaturePrivilegeGroupType"}]},{"id":"def-common.SubFeaturePrivilegeGroupConfig.privileges","type":"Object","label":"privileges","description":["\nThe privileges which belong to this group."],"source":{"path":"x-pack/plugins/features/common/sub_feature.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L50"},"signature":["readonly ",{"pluginId":"features","scope":"common","docId":"kibFeaturesPluginApi","section":"def-common.SubFeaturePrivilegeConfig","text":"SubFeaturePrivilegeConfig"},"[]"]}],"source":{"path":"x-pack/plugins/features/common/sub_feature.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L36"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-common.SubFeaturePrivilegeGroupType","type":"Type","label":"SubFeaturePrivilegeGroupType","description":["\nThe type of privilege group.\n- `mutually_exclusive`::\n Users will be able to select at most one privilege within this group.\n Privileges must be specified in descending order of permissiveness (e.g. `All`, `Read`, not `Read`, `All)\n- `independent`::\n Users will be able to select any combination of privileges within this group."],"source":{"path":"x-pack/plugins/features/common/sub_feature.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/features/common/sub_feature.ts#L31"},"signature":["\"mutually_exclusive\" | \"independent\""],"initialIsOpen":false}],"objects":[]}} \ No newline at end of file diff --git a/api_docs/features.mdx b/api_docs/features.mdx new file mode 100644 index 0000000000000..08f7a8f04d058 --- /dev/null +++ b/api_docs/features.mdx @@ -0,0 +1,38 @@ +--- +id: kibFeaturesPluginApi +slug: /kibana-dev-docs/featuresPluginApi +title: features +image: https://source.unsplash.com/400x175/?github +summary: API docs for the features plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'features'] +--- + +import featuresObj from './features.json'; + +## Client + +### Setup + +### Start + +### Classes + +### Interfaces + +## Server + +### Objects + +### Classes + +### Interfaces + +## Common + +### Classes + +### Interfaces + +### Consts, variables and types + diff --git a/api_docs/file_upload.json b/api_docs/file_upload.json new file mode 100644 index 0000000000000..1352fdc18af6d --- /dev/null +++ b/api_docs/file_upload.json @@ -0,0 +1 @@ +{"id":"fileUpload","client":{"classes":[],"functions":[],"interfaces":[{"id":"def-public.FileUploadComponentProps","type":"Interface","label":"FileUploadComponentProps","description":[],"children":[{"id":"def-public.FileUploadComponentProps.isIndexingTriggered","type":"boolean","label":"isIndexingTriggered","description":[],"source":{"path":"x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/lazy_load_bundle/index.ts#L14"}},{"id":"def-public.FileUploadComponentProps.onFileUpload","type":"Function","label":"onFileUpload","description":[],"source":{"path":"x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/lazy_load_bundle/index.ts#L15"},"signature":["(geojsonFile: GeoJSON.FeatureCollection, name: string) => void"]},{"id":"def-public.FileUploadComponentProps.onFileRemove","type":"Function","label":"onFileRemove","description":[],"source":{"path":"x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/lazy_load_bundle/index.ts#L16"},"signature":["() => void"]},{"id":"def-public.FileUploadComponentProps.onIndexReady","type":"Function","label":"onIndexReady","description":[],"source":{"path":"x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/lazy_load_bundle/index.ts#L17"},"signature":["(indexReady: boolean) => void"]},{"id":"def-public.FileUploadComponentProps.onIndexingComplete","type":"Function","label":"onIndexingComplete","description":[],"source":{"path":"x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/lazy_load_bundle/index.ts#L18"},"signature":["(results: { indexDataResp: ",{"pluginId":"fileUpload","scope":"public","docId":"kibFileUploadPluginApi","section":"def-public.ImportResults","text":"ImportResults"},"; indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},"; }) => void"]},{"id":"def-public.FileUploadComponentProps.onIndexingError","type":"Function","label":"onIndexingError","description":[],"source":{"path":"x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/lazy_load_bundle/index.ts#L22"},"signature":["() => void"]}],"source":{"path":"x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/lazy_load_bundle/index.ts#L13"},"initialIsOpen":false},{"id":"def-public.ImportResponse","type":"Interface","label":"ImportResponse","description":[],"children":[{"id":"def-public.ImportResponse.success","type":"boolean","label":"success","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L9"}},{"id":"def-public.ImportResponse.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L10"}},{"id":"def-public.ImportResponse.index","type":"string","label":"index","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L11"},"signature":["string | undefined"]},{"id":"def-public.ImportResponse.pipelineId","type":"string","label":"pipelineId","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L12"},"signature":["string | undefined"]},{"id":"def-public.ImportResponse.docCount","type":"number","label":"docCount","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L13"}},{"id":"def-public.ImportResponse.failures","type":"Array","label":"failures","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L14"},"signature":[{"pluginId":"fileUpload","scope":"common","docId":"kibFileUploadPluginApi","section":"def-common.ImportFailure","text":"ImportFailure"},"[]"]},{"id":"def-public.ImportResponse.error","type":"Any","label":"error","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L15"},"signature":["any"]},{"id":"def-public.ImportResponse.ingestError","type":"CompoundType","label":"ingestError","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L16"},"signature":["boolean | undefined"]}],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L8"},"initialIsOpen":false},{"id":"def-public.ImportFailure","type":"Interface","label":"ImportFailure","description":[],"children":[{"id":"def-public.ImportFailure.item","type":"number","label":"item","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L20"}},{"id":"def-public.ImportFailure.reason","type":"string","label":"reason","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L21"}},{"id":"def-public.ImportFailure.doc","type":"CompoundType","label":"doc","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L22"},"signature":[{"pluginId":"fileUpload","scope":"common","docId":"kibFileUploadPluginApi","section":"def-common.ImportDoc","text":"ImportDoc"}]}],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L19"},"initialIsOpen":false},{"id":"def-public.Doc","type":"Interface","label":"Doc","description":[],"children":[{"id":"def-public.Doc.message","type":"string","label":"message","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L26"}}],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L25"},"initialIsOpen":false},{"id":"def-public.Settings","type":"Interface","label":"Settings","description":[],"children":[{"id":"def-public.Settings.pipeline","type":"string","label":"pipeline","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L32"},"signature":["string | undefined"]},{"id":"def-public.Settings.index","type":"string","label":"index","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L33"}},{"id":"def-public.Settings.body","type":"Array","label":"body","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L34"},"signature":["any[]"]},{"id":"def-public.Settings.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L35"},"signature":["any"]}],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L31"},"initialIsOpen":false},{"id":"def-public.Mappings","type":"Interface","label":"Mappings","description":[],"children":[{"id":"def-public.Mappings._meta","type":"Object","label":"_meta","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L39"},"signature":["{ created_by: string; } | undefined"]},{"id":"def-public.Mappings.properties","type":"Object","label":"properties","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L42"},"signature":["{ [key: string]: any; }"]}],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L38"},"initialIsOpen":false},{"id":"def-public.IngestPipelineWrapper","type":"Interface","label":"IngestPipelineWrapper","description":[],"children":[{"id":"def-public.IngestPipelineWrapper.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L48"}},{"id":"def-public.IngestPipelineWrapper.pipeline","type":"Object","label":"pipeline","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L49"},"signature":[{"pluginId":"fileUpload","scope":"common","docId":"kibFileUploadPluginApi","section":"def-common.IngestPipeline","text":"IngestPipeline"}]}],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L47"},"initialIsOpen":false},{"id":"def-public.IngestPipeline","type":"Interface","label":"IngestPipeline","description":[],"children":[{"id":"def-public.IngestPipeline.description","type":"string","label":"description","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L53"}},{"id":"def-public.IngestPipeline.processors","type":"Array","label":"processors","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L54"},"signature":["any[]"]}],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L52"},"initialIsOpen":false},{"id":"def-public.ImportConfig","type":"Interface","label":"ImportConfig","description":[],"children":[{"id":"def-public.ImportConfig.settings","type":"Object","label":"settings","description":[],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L11"},"signature":[{"pluginId":"fileUpload","scope":"common","docId":"kibFileUploadPluginApi","section":"def-common.Settings","text":"Settings"}]},{"id":"def-public.ImportConfig.mappings","type":"Object","label":"mappings","description":[],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L12"},"signature":[{"pluginId":"fileUpload","scope":"common","docId":"kibFileUploadPluginApi","section":"def-common.Mappings","text":"Mappings"}]},{"id":"def-public.ImportConfig.pipeline","type":"Object","label":"pipeline","description":[],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L13"},"signature":[{"pluginId":"fileUpload","scope":"common","docId":"kibFileUploadPluginApi","section":"def-common.IngestPipeline","text":"IngestPipeline"}]}],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L10"},"initialIsOpen":false},{"id":"def-public.ImportResults","type":"Interface","label":"ImportResults","description":[],"children":[{"id":"def-public.ImportResults.success","type":"boolean","label":"success","description":[],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L17"}},{"id":"def-public.ImportResults.failures","type":"Array","label":"failures","description":[],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L18"},"signature":["any[] | undefined"]},{"id":"def-public.ImportResults.docCount","type":"number","label":"docCount","description":[],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L19"},"signature":["number | undefined"]},{"id":"def-public.ImportResults.error","type":"Any","label":"error","description":[],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L20"},"signature":["any"]}],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L16"},"initialIsOpen":false},{"id":"def-public.CreateDocsResponse","type":"Interface","label":"CreateDocsResponse","description":[],"children":[{"id":"def-public.CreateDocsResponse.success","type":"boolean","label":"success","description":[],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L24"}},{"id":"def-public.CreateDocsResponse.remainder","type":"number","label":"remainder","description":[],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L25"}},{"id":"def-public.CreateDocsResponse.docs","type":"Array","label":"docs","description":[],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L26"},"signature":[{"pluginId":"fileUpload","scope":"common","docId":"kibFileUploadPluginApi","section":"def-common.ImportDoc","text":"ImportDoc"},"[]"]},{"id":"def-public.CreateDocsResponse.error","type":"Any","label":"error","description":[],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L27"},"signature":["any"]}],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L23"},"initialIsOpen":false},{"id":"def-public.ImportFactoryOptions","type":"Interface","label":"ImportFactoryOptions","description":[],"children":[{"id":"def-public.ImportFactoryOptions.excludeLinesPattern","type":"string","label":"excludeLinesPattern","description":[],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L31"},"signature":["string | undefined"]},{"id":"def-public.ImportFactoryOptions.multilineStartPattern","type":"string","label":"multilineStartPattern","description":[],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L32"},"signature":["string | undefined"]},{"id":"def-public.ImportFactoryOptions.importConfig","type":"Object","label":"importConfig","description":[],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L33"},"signature":[{"pluginId":"fileUpload","scope":"public","docId":"kibFileUploadPluginApi","section":"def-public.ImportConfig","text":"ImportConfig"}]}],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L30"},"initialIsOpen":false},{"id":"def-public.IImporter","type":"Interface","label":"IImporter","description":[],"children":[{"id":"def-public.IImporter.read","type":"Function","label":"read","signature":["(data: ArrayBuffer) => { success: boolean; }"],"description":[],"children":[{"type":"Object","label":"data","isRequired":true,"signature":["ArrayBuffer"],"description":[],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L37"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L37"}},{"id":"def-public.IImporter.initializeImport","type":"Function","label":"initializeImport","signature":["(index: string, settings: ",{"pluginId":"fileUpload","scope":"common","docId":"kibFileUploadPluginApi","section":"def-common.Settings","text":"Settings"},", mappings: ",{"pluginId":"fileUpload","scope":"common","docId":"kibFileUploadPluginApi","section":"def-common.Mappings","text":"Mappings"},", pipeline: ",{"pluginId":"fileUpload","scope":"common","docId":"kibFileUploadPluginApi","section":"def-common.IngestPipeline","text":"IngestPipeline"},") => Promise<",{"pluginId":"fileUpload","scope":"common","docId":"kibFileUploadPluginApi","section":"def-common.ImportResponse","text":"ImportResponse"},">"],"description":[],"children":[{"type":"string","label":"index","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L39"}},{"type":"Object","label":"settings","isRequired":true,"signature":[{"pluginId":"fileUpload","scope":"common","docId":"kibFileUploadPluginApi","section":"def-common.Settings","text":"Settings"}],"description":[],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L40"}},{"type":"Object","label":"mappings","isRequired":true,"signature":[{"pluginId":"fileUpload","scope":"common","docId":"kibFileUploadPluginApi","section":"def-common.Mappings","text":"Mappings"}],"description":[],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L41"}},{"type":"Object","label":"pipeline","isRequired":true,"signature":[{"pluginId":"fileUpload","scope":"common","docId":"kibFileUploadPluginApi","section":"def-common.IngestPipeline","text":"IngestPipeline"}],"description":[],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L42"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L38"}},{"id":"def-public.IImporter.import","type":"Function","label":"import","signature":["(id: string, index: string, pipelineId: string, setImportProgress: (progress: number) => void) => Promise<",{"pluginId":"fileUpload","scope":"public","docId":"kibFileUploadPluginApi","section":"def-public.ImportResults","text":"ImportResults"},">"],"description":[],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L45"}},{"type":"string","label":"index","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L46"}},{"type":"string","label":"pipelineId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L47"}},{"type":"Function","label":"setImportProgress","isRequired":true,"signature":["(progress: number) => void"],"description":[],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L48"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L44"}}],"source":{"path":"x-pack/plugins/file_upload/public/importer/types.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/importer/types.ts#L36"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-public.MB","type":"number","label":"MB","description":[],"source":{"path":"x-pack/plugins/file_upload/common/constants.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L8"},"initialIsOpen":false},{"id":"def-public.MAX_FILE_SIZE","type":"string","label":"MAX_FILE_SIZE","description":[],"source":{"path":"x-pack/plugins/file_upload/common/constants.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L9"},"signature":["\"100MB\""],"initialIsOpen":false},{"id":"def-public.MAX_FILE_SIZE_BYTES","type":"number","label":"MAX_FILE_SIZE_BYTES","description":[],"source":{"path":"x-pack/plugins/file_upload/common/constants.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L10"},"signature":["104857600"],"initialIsOpen":false},{"id":"def-public.ABSOLUTE_MAX_FILE_SIZE_BYTES","type":"number","label":"ABSOLUTE_MAX_FILE_SIZE_BYTES","description":[],"source":{"path":"x-pack/plugins/file_upload/common/constants.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L12"},"signature":["1073741274"],"initialIsOpen":false},{"id":"def-public.FILE_SIZE_DISPLAY_FORMAT","type":"string","label":"FILE_SIZE_DISPLAY_FORMAT","description":[],"source":{"path":"x-pack/plugins/file_upload/common/constants.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L13"},"signature":["\"0,0.[0] b\""],"initialIsOpen":false},{"id":"def-public.INDEX_META_DATA_CREATED_BY","type":"string","label":"INDEX_META_DATA_CREATED_BY","description":[],"source":{"path":"x-pack/plugins/file_upload/common/constants.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L17"},"signature":["\"ml-file-data-visualizer\""],"initialIsOpen":false},{"id":"def-public.ImportDoc","type":"Type","label":"ImportDoc","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L29"},"signature":["string | object | ",{"pluginId":"fileUpload","scope":"common","docId":"kibFileUploadPluginApi","section":"def-common.Doc","text":"Doc"}],"initialIsOpen":false}],"objects":[],"start":{"id":"def-public.FileUploadPluginStart","type":"Type","label":"FileUploadPluginStart","description":[],"source":{"path":"x-pack/plugins/file_upload/public/plugin.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/public/plugin.ts#L20"},"signature":["FileUploadStartApi"],"lifecycle":"start","initialIsOpen":true}},"server":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"common":{"classes":[],"functions":[],"interfaces":[{"id":"def-common.ImportResponse","type":"Interface","label":"ImportResponse","description":[],"children":[{"id":"def-common.ImportResponse.success","type":"boolean","label":"success","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L9"}},{"id":"def-common.ImportResponse.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L10"}},{"id":"def-common.ImportResponse.index","type":"string","label":"index","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L11"},"signature":["string | undefined"]},{"id":"def-common.ImportResponse.pipelineId","type":"string","label":"pipelineId","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L12"},"signature":["string | undefined"]},{"id":"def-common.ImportResponse.docCount","type":"number","label":"docCount","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L13"}},{"id":"def-common.ImportResponse.failures","type":"Array","label":"failures","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L14"},"signature":[{"pluginId":"fileUpload","scope":"common","docId":"kibFileUploadPluginApi","section":"def-common.ImportFailure","text":"ImportFailure"},"[]"]},{"id":"def-common.ImportResponse.error","type":"Any","label":"error","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L15"},"signature":["any"]},{"id":"def-common.ImportResponse.ingestError","type":"CompoundType","label":"ingestError","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L16"},"signature":["boolean | undefined"]}],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L8"},"initialIsOpen":false},{"id":"def-common.ImportFailure","type":"Interface","label":"ImportFailure","description":[],"children":[{"id":"def-common.ImportFailure.item","type":"number","label":"item","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L20"}},{"id":"def-common.ImportFailure.reason","type":"string","label":"reason","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L21"}},{"id":"def-common.ImportFailure.doc","type":"CompoundType","label":"doc","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L22"},"signature":[{"pluginId":"fileUpload","scope":"common","docId":"kibFileUploadPluginApi","section":"def-common.ImportDoc","text":"ImportDoc"}]}],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L19"},"initialIsOpen":false},{"id":"def-common.Doc","type":"Interface","label":"Doc","description":[],"children":[{"id":"def-common.Doc.message","type":"string","label":"message","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L26"}}],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L25"},"initialIsOpen":false},{"id":"def-common.Settings","type":"Interface","label":"Settings","description":[],"children":[{"id":"def-common.Settings.pipeline","type":"string","label":"pipeline","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L32"},"signature":["string | undefined"]},{"id":"def-common.Settings.index","type":"string","label":"index","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L33"}},{"id":"def-common.Settings.body","type":"Array","label":"body","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L34"},"signature":["any[]"]},{"id":"def-common.Settings.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L35"},"signature":["any"]}],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L31"},"initialIsOpen":false},{"id":"def-common.Mappings","type":"Interface","label":"Mappings","description":[],"children":[{"id":"def-common.Mappings._meta","type":"Object","label":"_meta","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L39"},"signature":["{ created_by: string; } | undefined"]},{"id":"def-common.Mappings.properties","type":"Object","label":"properties","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L42"},"signature":["{ [key: string]: any; }"]}],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L38"},"initialIsOpen":false},{"id":"def-common.IngestPipelineWrapper","type":"Interface","label":"IngestPipelineWrapper","description":[],"children":[{"id":"def-common.IngestPipelineWrapper.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L48"}},{"id":"def-common.IngestPipelineWrapper.pipeline","type":"Object","label":"pipeline","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L49"},"signature":[{"pluginId":"fileUpload","scope":"common","docId":"kibFileUploadPluginApi","section":"def-common.IngestPipeline","text":"IngestPipeline"}]}],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L47"},"initialIsOpen":false},{"id":"def-common.IngestPipeline","type":"Interface","label":"IngestPipeline","description":[],"children":[{"id":"def-common.IngestPipeline.description","type":"string","label":"description","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L53"}},{"id":"def-common.IngestPipeline.processors","type":"Array","label":"processors","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L54"},"signature":["any[]"]}],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L52"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-common.MB","type":"number","label":"MB","description":[],"source":{"path":"x-pack/plugins/file_upload/common/constants.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L8"},"initialIsOpen":false},{"id":"def-common.MAX_FILE_SIZE","type":"string","label":"MAX_FILE_SIZE","description":[],"source":{"path":"x-pack/plugins/file_upload/common/constants.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L9"},"signature":["\"100MB\""],"initialIsOpen":false},{"id":"def-common.MAX_FILE_SIZE_BYTES","type":"number","label":"MAX_FILE_SIZE_BYTES","description":[],"source":{"path":"x-pack/plugins/file_upload/common/constants.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L10"},"signature":["104857600"],"initialIsOpen":false},{"id":"def-common.ABSOLUTE_MAX_FILE_SIZE_BYTES","type":"number","label":"ABSOLUTE_MAX_FILE_SIZE_BYTES","description":[],"source":{"path":"x-pack/plugins/file_upload/common/constants.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L12"},"signature":["1073741274"],"initialIsOpen":false},{"id":"def-common.FILE_SIZE_DISPLAY_FORMAT","type":"string","label":"FILE_SIZE_DISPLAY_FORMAT","description":[],"source":{"path":"x-pack/plugins/file_upload/common/constants.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L13"},"signature":["\"0,0.[0] b\""],"initialIsOpen":false},{"id":"def-common.INDEX_META_DATA_CREATED_BY","type":"string","label":"INDEX_META_DATA_CREATED_BY","description":[],"source":{"path":"x-pack/plugins/file_upload/common/constants.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/constants.ts#L17"},"signature":["\"ml-file-data-visualizer\""],"initialIsOpen":false},{"id":"def-common.ImportDoc","type":"Type","label":"ImportDoc","description":[],"source":{"path":"x-pack/plugins/file_upload/common/types.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/file_upload/common/types.ts#L29"},"signature":["string | object | ",{"pluginId":"fileUpload","scope":"common","docId":"kibFileUploadPluginApi","section":"def-common.Doc","text":"Doc"}],"initialIsOpen":false}],"objects":[]}} \ No newline at end of file diff --git a/api_docs/file_upload.mdx b/api_docs/file_upload.mdx new file mode 100644 index 0000000000000..64ad30fadc93c --- /dev/null +++ b/api_docs/file_upload.mdx @@ -0,0 +1,26 @@ +--- +id: kibFileUploadPluginApi +slug: /kibana-dev-docs/fileUploadPluginApi +title: fileUpload +image: https://source.unsplash.com/400x175/?github +summary: API docs for the fileUpload plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fileUpload'] +--- + +import fileUploadObj from './file_upload.json'; + +## Client + +### Start + +### Interfaces + +### Consts, variables and types + +## Common + +### Interfaces + +### Consts, variables and types + diff --git a/api_docs/fleet.json b/api_docs/fleet.json new file mode 100644 index 0000000000000..00624fc01de4e --- /dev/null +++ b/api_docs/fleet.json @@ -0,0 +1 @@ +{"id":"fleet","client":{"classes":[],"functions":[{"id":"def-public.pkgKeyFromPackageInfo","type":"Function","children":[{"type":"Uncategorized","label":"packageInfo","isRequired":true,"signature":["T"],"description":[],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/services/pkg_key_from_package_info.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/services/pkg_key_from_package_info.ts#L9"}}],"signature":["(packageInfo: T) => string"],"description":[],"label":"pkgKeyFromPackageInfo","source":{"path":"x-pack/plugins/fleet/public/applications/fleet/services/pkg_key_from_package_info.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/services/pkg_key_from_package_info.ts#L8"},"returnComment":[],"initialIsOpen":false}],"interfaces":[{"id":"def-public.NewPackagePolicy","type":"Interface","label":"NewPackagePolicy","description":[],"children":[{"id":"def-public.NewPackagePolicy.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L50"}},{"id":"def-public.NewPackagePolicy.description","type":"string","label":"description","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L51"},"signature":["string | undefined"]},{"id":"def-public.NewPackagePolicy.namespace","type":"string","label":"namespace","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L52"}},{"id":"def-public.NewPackagePolicy.enabled","type":"boolean","label":"enabled","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L53"}},{"id":"def-public.NewPackagePolicy.policy_id","type":"string","label":"policy_id","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L54"}},{"id":"def-public.NewPackagePolicy.output_id","type":"string","label":"output_id","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L55"}},{"id":"def-public.NewPackagePolicy.package","type":"Object","label":"package","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L56"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.PackagePolicyPackage","text":"PackagePolicyPackage"}," | undefined"]},{"id":"def-public.NewPackagePolicy.inputs","type":"Array","label":"inputs","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L57"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.NewPackagePolicyInput","text":"NewPackagePolicyInput"},"[]"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L49"},"initialIsOpen":false},{"id":"def-public.CreatePackagePolicyRouteState","type":"Interface","label":"CreatePackagePolicyRouteState","description":["\nSupported routing state for the create package policy page routes"],"children":[{"id":"def-public.CreatePackagePolicyRouteState.onSaveNavigateTo","type":"CompoundType","label":"onSaveNavigateTo","description":["On a successful save of the package policy, use navigate to the given app"],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts#L16"},"signature":["[appId: string, options?: ",{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.NavigateToAppOptions","text":"NavigateToAppOptions"}," | undefined] | ((newPackagePolicy: ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.PackagePolicy","text":"PackagePolicy"},") => [appId: string, options?: ",{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.NavigateToAppOptions","text":"NavigateToAppOptions"}," | undefined]) | undefined"]},{"id":"def-public.CreatePackagePolicyRouteState.onCancelNavigateTo","type":"Object","label":"onCancelNavigateTo","description":["On cancel, navigate to the given app"],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts#L20"},"signature":["[appId: string, options?: ",{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.NavigateToAppOptions","text":"NavigateToAppOptions"}," | undefined] | undefined"]},{"id":"def-public.CreatePackagePolicyRouteState.onCancelUrl","type":"string","label":"onCancelUrl","description":["Url to be used on cancel links"],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts#L22"},"signature":["string | undefined"]}],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts#L14"},"initialIsOpen":false},{"id":"def-public.AgentPolicyDetailsDeployAgentAction","type":"Interface","label":"AgentPolicyDetailsDeployAgentAction","description":["\nSupported routing state for the agent policy details page routes with deploy agents action"],"children":[{"id":"def-public.AgentPolicyDetailsDeployAgentAction.onDoneNavigateTo","type":"Object","label":"onDoneNavigateTo","description":["On done, navigate to the given app"],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts#L30"},"signature":["[appId: string, options?: ",{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.NavigateToAppOptions","text":"NavigateToAppOptions"}," | undefined] | undefined"]}],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts#L28"},"initialIsOpen":false},{"id":"def-public.AgentDetailsReassignPolicyAction","type":"Interface","label":"AgentDetailsReassignPolicyAction","description":["\nSupported routing state for the agent policy details page routes with deploy agents action"],"children":[{"id":"def-public.AgentDetailsReassignPolicyAction.onDoneNavigateTo","type":"Object","label":"onDoneNavigateTo","description":["On done, navigate to the given app"],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts#L38"},"signature":["[appId: string, options?: ",{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.NavigateToAppOptions","text":"NavigateToAppOptions"}," | undefined] | undefined"]}],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts#L36"},"initialIsOpen":false},{"id":"def-public.UIExtensionsStorage","type":"Interface","label":"UIExtensionsStorage","description":["Internal storage for registered UI Extension Points"],"children":[{"id":"def-public.UIExtensionsStorage.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L16"},"signature":["any"]}],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L15"},"initialIsOpen":false},{"id":"def-public.PackagePolicyEditExtensionComponentProps","type":"Interface","label":"PackagePolicyEditExtensionComponentProps","description":[],"children":[{"id":"def-public.PackagePolicyEditExtensionComponentProps.policy","type":"Object","label":"policy","description":["The current integration policy being edited"],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L27"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.PackagePolicy","text":"PackagePolicy"}]},{"id":"def-public.PackagePolicyEditExtensionComponentProps.newPolicy","type":"Object","label":"newPolicy","description":["The new (updated) integration policy that will be saved"],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L29"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.NewPackagePolicy","text":"NewPackagePolicy"}]},{"id":"def-public.PackagePolicyEditExtensionComponentProps.onChange","type":"Function","label":"onChange","description":["\nA callback that should be executed anytime a change to the Integration Policy needs to\nbe reported back to the Fleet Policy Edit page.\n\n**NOTE:**\nthis callback will be recreated everytime the policy data changes, thus logic around its\ninvocation should take that into consideration in order to avoid an endless loop."],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L38"},"signature":["(opts: { isValid: boolean; updatedPolicy: Partial<",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.NewPackagePolicy","text":"NewPackagePolicy"},">; }) => void"]}],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L25"},"initialIsOpen":false},{"id":"def-public.PackagePolicyEditExtension","type":"Interface","label":"PackagePolicyEditExtension","description":["Extension point registration contract for Integration Policy Edit views"],"children":[{"id":"def-public.PackagePolicyEditExtension.package","type":"string","label":"package","description":[],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L48"}},{"id":"def-public.PackagePolicyEditExtension.view","type":"string","label":"view","description":[],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L49"},"signature":["\"package-policy-edit\""]},{"id":"def-public.PackagePolicyEditExtension.component","type":"Function","label":"component","description":[],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L50"},"signature":["React.LazyExoticComponent>"]}],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L47"},"initialIsOpen":false},{"id":"def-public.PackagePolicyCreateExtensionComponentProps","type":"Interface","label":"PackagePolicyCreateExtensionComponentProps","description":[],"children":[{"id":"def-public.PackagePolicyCreateExtensionComponentProps.newPolicy","type":"Object","label":"newPolicy","description":["The integration policy being created"],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L61"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.NewPackagePolicy","text":"NewPackagePolicy"}]},{"id":"def-public.PackagePolicyCreateExtensionComponentProps.onChange","type":"Function","label":"onChange","description":["\nA callback that should be executed anytime a change to the Integration Policy needs to\nbe reported back to the Fleet Policy Edit page"],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L66"},"signature":["(opts: { isValid: boolean; updatedPolicy: ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.NewPackagePolicy","text":"NewPackagePolicy"},"; }) => void"]}],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L59"},"initialIsOpen":false},{"id":"def-public.PackagePolicyCreateExtension","type":"Interface","label":"PackagePolicyCreateExtension","description":["Extension point registration contract for Integration Policy Create views"],"children":[{"id":"def-public.PackagePolicyCreateExtension.package","type":"string","label":"package","description":[],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts","lineNumber":76,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L76"}},{"id":"def-public.PackagePolicyCreateExtension.view","type":"string","label":"view","description":[],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L77"},"signature":["\"package-policy-create\""]},{"id":"def-public.PackagePolicyCreateExtension.component","type":"Function","label":"component","description":[],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L78"},"signature":["React.LazyExoticComponent>"]}],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L75"},"initialIsOpen":false},{"id":"def-public.PackageCustomExtensionComponentProps","type":"Interface","label":"PackageCustomExtensionComponentProps","description":[],"children":[{"id":"def-public.PackageCustomExtensionComponentProps.pkgkey","type":"string","label":"pkgkey","description":["The package key value that should be used used for URLs"],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L88"}},{"id":"def-public.PackageCustomExtensionComponentProps.packageInfo","type":"CompoundType","label":"packageInfo","description":[],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L89"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.PackageInfo","text":"PackageInfo"}]}],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L86"},"initialIsOpen":false},{"id":"def-public.PackageCustomExtension","type":"Interface","label":"PackageCustomExtension","description":["Extension point registration contract for Integration details Custom view"],"children":[{"id":"def-public.PackageCustomExtension.package","type":"string","label":"package","description":[],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L94"}},{"id":"def-public.PackageCustomExtension.view","type":"string","label":"view","description":[],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L95"},"signature":["\"package-detail-custom\""]},{"id":"def-public.PackageCustomExtension.component","type":"Function","label":"component","description":[],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L96"},"signature":["React.LazyExoticComponent>"]}],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts","lineNumber":93,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L93"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-public.AnyIntraAppRouteState","type":"Type","label":"AnyIntraAppRouteState","description":["\nAll possible Route states."],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/intra_app_route_state.ts#L44"},"signature":[{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.CreatePackagePolicyRouteState","text":"CreatePackagePolicyRouteState"}," | ",{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.AgentPolicyDetailsDeployAgentAction","text":"AgentPolicyDetailsDeployAgentAction"}," | ",{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.AgentDetailsReassignPolicyAction","text":"AgentDetailsReassignPolicyAction"}],"initialIsOpen":false},{"id":"def-public.UIExtensionRegistrationCallback","type":"Type","label":"UIExtensionRegistrationCallback","description":["Register a Fleet UI extension"],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L12"},"signature":["(extensionPoint: ",{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.UIExtensionPoint","text":"UIExtensionPoint"},") => void"],"initialIsOpen":false},{"id":"def-public.PackagePolicyEditExtensionComponent","type":"Type","label":"PackagePolicyEditExtensionComponent","description":["\nUI Component Extension is used on the pages displaying the ability to edit an\nIntegration Policy"],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L23"},"signature":["React.ComponentClass<",{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.PackagePolicyEditExtensionComponentProps","text":"PackagePolicyEditExtensionComponentProps"},", any> | React.FunctionComponent<",{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.PackagePolicyEditExtensionComponentProps","text":"PackagePolicyEditExtensionComponentProps"},">"],"initialIsOpen":false},{"id":"def-public.PackagePolicyCreateExtensionComponent","type":"Type","label":"PackagePolicyCreateExtensionComponent","description":["\nUI Component Extension is used on the pages displaying the ability to Create an\nIntegration Policy"],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L57"},"signature":["React.ComponentClass<",{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.PackagePolicyCreateExtensionComponentProps","text":"PackagePolicyCreateExtensionComponentProps"},", any> | React.FunctionComponent<",{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.PackagePolicyCreateExtensionComponentProps","text":"PackagePolicyCreateExtensionComponentProps"},">"],"initialIsOpen":false},{"id":"def-public.PackageCustomExtensionComponent","type":"Type","label":"PackageCustomExtensionComponent","description":["\nUI Component Extension is used to display a Custom tab (and view) under a given Integration"],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L84"},"signature":["React.ComponentClass<",{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.PackageCustomExtensionComponentProps","text":"PackageCustomExtensionComponentProps"},", any> | React.FunctionComponent<",{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.PackageCustomExtensionComponentProps","text":"PackageCustomExtensionComponentProps"},">"],"initialIsOpen":false},{"id":"def-public.UIExtensionPoint","type":"Type","label":"UIExtensionPoint","description":["Fleet UI Extension Point"],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts","lineNumber":100,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/types/ui_extensions.ts#L100"},"signature":[{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.PackagePolicyEditExtension","text":"PackagePolicyEditExtension"}," | ",{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.PackageCustomExtension","text":"PackageCustomExtension"}," | ",{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.PackagePolicyCreateExtension","text":"PackagePolicyCreateExtension"}],"initialIsOpen":false}],"objects":[{"id":"def-public.pagePathGetters","type":"Object","children":[{"id":"def-public.pagePathGetters.base","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"base","source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L75"},"returnComment":[]},{"id":"def-public.pagePathGetters.overview","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"overview","source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":76,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L76"},"returnComment":[]},{"id":"def-public.pagePathGetters.integrations","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"integrations","source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L77"},"returnComment":[]},{"id":"def-public.pagePathGetters.integrations_all","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"integrations_all","source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L78"},"returnComment":[]},{"id":"def-public.pagePathGetters.integrations_installed","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"integrations_installed","source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L79"},"returnComment":[]},{"id":"def-public.pagePathGetters.integration_details_overview","type":"Function","children":[{"type":"Object","label":"{ pkgkey }","isRequired":true,"signature":[{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.DynamicPagePathValues","text":"DynamicPagePathValues"}],"description":[],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L80"}}],"signature":["({ pkgkey }: ",{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.DynamicPagePathValues","text":"DynamicPagePathValues"},") => string"],"description":[],"label":"integration_details_overview","source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L80"},"returnComment":[]},{"id":"def-public.pagePathGetters.integration_details_policies","type":"Function","children":[{"type":"Object","label":"{ pkgkey }","isRequired":true,"signature":[{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.DynamicPagePathValues","text":"DynamicPagePathValues"}],"description":[],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L81"}}],"signature":["({ pkgkey }: ",{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.DynamicPagePathValues","text":"DynamicPagePathValues"},") => string"],"description":[],"label":"integration_details_policies","source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L81"},"returnComment":[]},{"id":"def-public.pagePathGetters.integration_details_settings","type":"Function","children":[{"type":"Object","label":"{ pkgkey }","isRequired":true,"signature":[{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.DynamicPagePathValues","text":"DynamicPagePathValues"}],"description":[],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L82"}}],"signature":["({ pkgkey }: ",{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.DynamicPagePathValues","text":"DynamicPagePathValues"},") => string"],"description":[],"label":"integration_details_settings","source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L82"},"returnComment":[]},{"id":"def-public.pagePathGetters.integration_details_custom","type":"Function","children":[{"type":"Object","label":"{ pkgkey }","isRequired":true,"signature":[{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.DynamicPagePathValues","text":"DynamicPagePathValues"}],"description":[],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L83"}}],"signature":["({ pkgkey }: ",{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.DynamicPagePathValues","text":"DynamicPagePathValues"},") => string"],"description":[],"label":"integration_details_custom","source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L83"},"returnComment":[]},{"id":"def-public.pagePathGetters.integration_policy_edit","type":"Function","children":[{"type":"Object","label":"{ packagePolicyId }","isRequired":true,"signature":[{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.DynamicPagePathValues","text":"DynamicPagePathValues"}],"description":[],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L84"}}],"signature":["({ packagePolicyId }: ",{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.DynamicPagePathValues","text":"DynamicPagePathValues"},") => string"],"description":[],"label":"integration_policy_edit","source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L84"},"returnComment":[]},{"id":"def-public.pagePathGetters.policies","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"policies","source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L86"},"returnComment":[]},{"id":"def-public.pagePathGetters.policies_list","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"policies_list","source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":87,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L87"},"returnComment":[]},{"id":"def-public.pagePathGetters.policy_details","type":"Function","children":[{"type":"Object","label":"{ policyId, tabId }","isRequired":true,"signature":[{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.DynamicPagePathValues","text":"DynamicPagePathValues"}],"description":[],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L88"}}],"signature":["({ policyId, tabId }: ",{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.DynamicPagePathValues","text":"DynamicPagePathValues"},") => string"],"description":[],"label":"policy_details","source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L88"},"returnComment":[]},{"id":"def-public.pagePathGetters.add_integration_from_policy","type":"Function","children":[{"type":"Object","label":"{ policyId }","isRequired":true,"signature":[{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.DynamicPagePathValues","text":"DynamicPagePathValues"}],"description":[],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L89"}}],"signature":["({ policyId }: ",{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.DynamicPagePathValues","text":"DynamicPagePathValues"},") => string"],"description":[],"label":"add_integration_from_policy","source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L89"},"returnComment":[]},{"id":"def-public.pagePathGetters.add_integration_to_policy","type":"Function","children":[{"type":"Object","label":"{ pkgkey }","isRequired":true,"signature":[{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.DynamicPagePathValues","text":"DynamicPagePathValues"}],"description":[],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L90"}}],"signature":["({ pkgkey }: ",{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.DynamicPagePathValues","text":"DynamicPagePathValues"},") => string"],"description":[],"label":"add_integration_to_policy","source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L90"},"returnComment":[]},{"id":"def-public.pagePathGetters.edit_integration","type":"Function","children":[{"type":"Object","label":"{ policyId, packagePolicyId }","isRequired":true,"signature":[{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.DynamicPagePathValues","text":"DynamicPagePathValues"}],"description":[],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":91,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L91"}}],"signature":["({ policyId, packagePolicyId }: ",{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.DynamicPagePathValues","text":"DynamicPagePathValues"},") => string"],"description":[],"label":"edit_integration","source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":91,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L91"},"returnComment":[]},{"id":"def-public.pagePathGetters.fleet","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"fleet","source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":93,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L93"},"returnComment":[]},{"id":"def-public.pagePathGetters.fleet_agent_list","type":"Function","children":[{"type":"Object","label":"{ kuery }","isRequired":true,"signature":[{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.DynamicPagePathValues","text":"DynamicPagePathValues"}],"description":[],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L94"}}],"signature":["({ kuery }: ",{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.DynamicPagePathValues","text":"DynamicPagePathValues"},") => string"],"description":[],"label":"fleet_agent_list","source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L94"},"returnComment":[]},{"id":"def-public.pagePathGetters.fleet_agent_details","type":"Function","children":[{"type":"Object","label":"{ agentId, tabId, logQuery }","isRequired":true,"signature":[{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.DynamicPagePathValues","text":"DynamicPagePathValues"}],"description":[],"source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L95"}}],"signature":["({ agentId, tabId, logQuery }: ",{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.DynamicPagePathValues","text":"DynamicPagePathValues"},") => string"],"description":[],"label":"fleet_agent_details","source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L95"},"returnComment":[]},{"id":"def-public.pagePathGetters.fleet_enrollment_tokens","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"fleet_enrollment_tokens","source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L97"},"returnComment":[]},{"id":"def-public.pagePathGetters.data_streams","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"data_streams","source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L98"},"returnComment":[]}],"description":[],"label":"pagePathGetters","source":{"path":"x-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/applications/fleet/constants/page_paths.ts#L69"},"initialIsOpen":false}],"setup":{"id":"def-public.FleetSetup","type":"Interface","label":"FleetSetup","description":[],"children":[],"source":{"path":"x-pack/plugins/fleet/public/plugin.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/plugin.ts#L44"},"lifecycle":"setup","initialIsOpen":true},"start":{"id":"def-public.FleetStart","type":"Interface","label":"FleetStart","description":["\nDescribes public Fleet plugin contract returned at the `start` stage."],"children":[{"id":"def-public.FleetStart.registerExtension","type":"Function","label":"registerExtension","description":[],"source":{"path":"x-pack/plugins/fleet/public/plugin.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/plugin.ts#L50"},"signature":[{"pluginId":"fleet","scope":"public","docId":"kibFleetPluginApi","section":"def-public.UIExtensionRegistrationCallback","text":"UIExtensionRegistrationCallback"}]},{"id":"def-public.FleetStart.isInitialized","type":"Function","label":"isInitialized","description":[],"source":{"path":"x-pack/plugins/fleet/public/plugin.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/plugin.ts#L51"},"signature":["() => Promise"]}],"source":{"path":"x-pack/plugins/fleet/public/plugin.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/public/plugin.ts#L49"},"lifecycle":"start","initialIsOpen":true}},"server":{"classes":[],"functions":[{"id":"def-server.getRegistryUrl","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"getRegistryUrl","source":{"path":"x-pack/plugins/fleet/server/services/epm/registry/registry_url.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/epm/registry/registry_url.ts#L33"},"returnComment":[],"initialIsOpen":false}],"interfaces":[{"id":"def-server.AgentService","type":"Interface","label":"AgentService","description":["\nA service that provides exported functions that return information about an Agent"],"children":[{"id":"def-server.AgentService.getAgent","type":"Function","label":"getAgent","description":["\nGet an Agent by id"],"source":{"path":"x-pack/plugins/fleet/server/services/index.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L46"},"signature":["typeof ",{"pluginId":"fleet","scope":"server","docId":"kibFleetPluginApi","section":"def-server.getAgent","text":"getAgent"}]},{"id":"def-server.AgentService.authenticateAgentWithAccessToken","type":"Function","label":"authenticateAgentWithAccessToken","signature":["(soClient: Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">, esClient: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ElasticsearchClient","text":"ElasticsearchClient"},", request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},") => Promise<",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.Agent","text":"Agent"},">"],"description":["\nAuthenticate an agent with access toekn"],"children":[{"type":"Object","label":"soClient","isRequired":true,"signature":["Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">"],"description":[],"source":{"path":"x-pack/plugins/fleet/server/services/index.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L51"}},{"type":"CompoundType","label":"esClient","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ElasticsearchClient","text":"ElasticsearchClient"}],"description":[],"source":{"path":"x-pack/plugins/fleet/server/services/index.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L52"}},{"type":"Object","label":"request","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},""],"description":[],"source":{"path":"x-pack/plugins/fleet/server/services/index.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L53"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/fleet/server/services/index.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L50"}},{"id":"def-server.AgentService.getAgentStatusById","type":"Function","label":"getAgentStatusById","signature":["(soClient: Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">, esClient: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ElasticsearchClient","text":"ElasticsearchClient"},", agentId: string) => Promise<",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AgentStatus","text":"AgentStatus"},">"],"description":["\nReturn the status by the Agent's id"],"children":[{"type":"Object","label":"soClient","isRequired":true,"signature":["Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">"],"description":[],"source":{"path":"x-pack/plugins/fleet/server/services/index.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L59"}},{"type":"CompoundType","label":"esClient","isRequired":true,"signature":[{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.ElasticsearchClient","text":"ElasticsearchClient"}],"description":[],"source":{"path":"x-pack/plugins/fleet/server/services/index.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L60"}},{"type":"string","label":"agentId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/server/services/index.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L61"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/fleet/server/services/index.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L58"}},{"id":"def-server.AgentService.listAgents","type":"Function","label":"listAgents","description":["\nList agents"],"source":{"path":"x-pack/plugins/fleet/server/services/index.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L66"},"signature":["typeof ",{"pluginId":"fleet","scope":"server","docId":"kibFleetPluginApi","section":"def-server.listAgents","text":"listAgents"}]}],"source":{"path":"x-pack/plugins/fleet/server/services/index.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L42"},"initialIsOpen":false},{"id":"def-server.ESIndexPatternService","type":"Interface","label":"ESIndexPatternService","description":["\nService to return the index pattern of EPM packages"],"children":[{"id":"def-server.ESIndexPatternService.getESIndexPattern","type":"Function","label":"getESIndexPattern","signature":["(savedObjectsClient: Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">, pkgName: string, datasetPath: string) => Promise"],"description":[],"children":[{"type":"Object","label":"savedObjectsClient","isRequired":true,"signature":["Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">"],"description":[],"source":{"path":"x-pack/plugins/fleet/server/services/index.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L22"}},{"type":"string","label":"pkgName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/server/services/index.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L23"}},{"type":"string","label":"datasetPath","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/server/services/index.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L24"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/fleet/server/services/index.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L21"}}],"source":{"path":"x-pack/plugins/fleet/server/services/index.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L20"},"initialIsOpen":false},{"id":"def-server.PackageService","type":"Interface","label":"PackageService","description":["\nService that provides exported function that return information about EPM packages"],"children":[{"id":"def-server.PackageService.getInstalledEsAssetReferences","type":"Function","label":"getInstalledEsAssetReferences","signature":["(savedObjectsClient: Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">, pkgName: string) => Promise<",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.EsAssetReference","text":"EsAssetReference"},"[]>"],"description":[],"children":[{"type":"Object","label":"savedObjectsClient","isRequired":true,"signature":["Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">"],"description":[],"source":{"path":"x-pack/plugins/fleet/server/services/index.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L34"}},{"type":"string","label":"pkgName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/server/services/index.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L35"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/fleet/server/services/index.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L33"}}],"source":{"path":"x-pack/plugins/fleet/server/services/index.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L32"},"initialIsOpen":false},{"id":"def-server.AgentPolicyServiceInterface","type":"Interface","label":"AgentPolicyServiceInterface","description":[],"children":[{"id":"def-server.AgentPolicyServiceInterface.get","type":"Function","label":"get","description":[],"source":{"path":"x-pack/plugins/fleet/server/services/index.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L70"},"signature":["(soClient: Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">, id: string, withPackagePolicies?: boolean) => Promise<",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AgentPolicy","text":"AgentPolicy"}," | null>"]},{"id":"def-server.AgentPolicyServiceInterface.list","type":"Function","label":"list","description":[],"source":{"path":"x-pack/plugins/fleet/server/services/index.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L71"},"signature":["(soClient: Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">, options: Readonly<{ page?: number | undefined; perPage?: number | undefined; sortField?: string | undefined; sortOrder?: \"asc\" | \"desc\" | undefined; kuery?: any; showUpgradeable?: boolean | undefined; } & {}> & { withPackagePolicies?: boolean | undefined; }) => Promise<{ items: ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AgentPolicy","text":"AgentPolicy"},"[]; total: number; page: number; perPage: number; }>"]},{"id":"def-server.AgentPolicyServiceInterface.getDefaultAgentPolicyId","type":"Function","label":"getDefaultAgentPolicyId","description":[],"source":{"path":"x-pack/plugins/fleet/server/services/index.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L72"},"signature":["(soClient: Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">) => Promise"]},{"id":"def-server.AgentPolicyServiceInterface.getFullAgentPolicy","type":"Function","label":"getFullAgentPolicy","description":[],"source":{"path":"x-pack/plugins/fleet/server/services/index.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L73"},"signature":["(soClient: Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">, id: string, options?: { standalone: boolean; } | undefined) => Promise<",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.FullAgentPolicy","text":"FullAgentPolicy"}," | null>"]}],"source":{"path":"x-pack/plugins/fleet/server/services/index.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/index.ts#L69"},"initialIsOpen":false},{"id":"def-server.FleetSetupDeps","type":"Interface","label":"FleetSetupDeps","description":[],"children":[{"id":"def-server.FleetSetupDeps.licensing","type":"Object","label":"licensing","description":[],"source":{"path":"x-pack/plugins/fleet/server/plugin.ts","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L89"},"signature":[{"pluginId":"licensing","scope":"server","docId":"kibLicensingPluginApi","section":"def-server.LicensingPluginSetup","text":"LicensingPluginSetup"}]},{"id":"def-server.FleetSetupDeps.security","type":"Object","label":"security","description":[],"source":{"path":"x-pack/plugins/fleet/server/plugin.ts","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L90"},"signature":[{"pluginId":"security","scope":"server","docId":"kibSecurityPluginApi","section":"def-server.SecurityPluginSetup","text":"SecurityPluginSetup"}," | undefined"]},{"id":"def-server.FleetSetupDeps.features","type":"Object","label":"features","description":[],"source":{"path":"x-pack/plugins/fleet/server/plugin.ts","lineNumber":91,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L91"},"signature":[{"pluginId":"features","scope":"server","docId":"kibFeaturesPluginApi","section":"def-server.PluginSetupContract","text":"PluginSetupContract"}," | undefined"]},{"id":"def-server.FleetSetupDeps.encryptedSavedObjects","type":"Object","label":"encryptedSavedObjects","description":[],"source":{"path":"x-pack/plugins/fleet/server/plugin.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L92"},"signature":[{"pluginId":"encryptedSavedObjects","scope":"server","docId":"kibEncryptedSavedObjectsPluginApi","section":"def-server.EncryptedSavedObjectsPluginSetup","text":"EncryptedSavedObjectsPluginSetup"}]},{"id":"def-server.FleetSetupDeps.cloud","type":"Object","label":"cloud","description":[],"source":{"path":"x-pack/plugins/fleet/server/plugin.ts","lineNumber":93,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L93"},"signature":[{"pluginId":"cloud","scope":"server","docId":"kibCloudPluginApi","section":"def-server.CloudSetup","text":"CloudSetup"}," | undefined"]},{"id":"def-server.FleetSetupDeps.usageCollection","type":"Object","label":"usageCollection","description":[],"source":{"path":"x-pack/plugins/fleet/server/plugin.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L94"},"signature":["Pick<",{"pluginId":"usageCollection","scope":"server","docId":"kibUsageCollectionPluginApi","section":"def-server.CollectorSet","text":"CollectorSet"},", \"makeStatsCollector\" | \"makeUsageCollector\" | \"registerCollector\" | \"getCollectorByType\" | \"areAllCollectorsReady\" | \"bulkFetch\" | \"bulkFetchUsage\" | \"toObject\" | \"toApiFieldNames\"> | undefined"]}],"source":{"path":"x-pack/plugins/fleet/server/plugin.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L88"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-server.ExternalCallback","type":"Type","label":"ExternalCallback","description":["\nCallbacks supported by the Fleet plugin"],"source":{"path":"x-pack/plugins/fleet/server/plugin.ts","lineNumber":132,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L132"},"signature":["[\"packagePolicyCreate\", (newPackagePolicy: ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.NewPackagePolicy","text":"NewPackagePolicy"},", context: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.RequestHandlerContext","text":"RequestHandlerContext"},", request: ",{"pluginId":"core","scope":"server","docId":"kibCoreHttpPluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},") => Promise<",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.NewPackagePolicy","text":"NewPackagePolicy"},">] | [\"packagePolicyUpdate\", (newPackagePolicy: ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.UpdatePackagePolicy","text":"UpdatePackagePolicy"}],"initialIsOpen":false},{"id":"def-server.FleetConfigType","type":"Type","label":"FleetConfigType","description":[],"source":{"path":"x-pack/plugins/fleet/server/index.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/index.ts#L72"},"signature":["any"],"initialIsOpen":false},{"id":"def-server.PackagePolicyServiceInterface","type":"Type","label":"PackagePolicyServiceInterface","description":[],"source":{"path":"x-pack/plugins/fleet/server/services/package_policy.ts","lineNumber":591,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/services/package_policy.ts#L591"},"signature":["PackagePolicyService"],"initialIsOpen":false}],"objects":[{"id":"def-server.agent","type":"Object","label":"agent","description":[],"source":{"path":"node_modules/elastic-apm-node/index.d.ts","lineNumber":7,"link":"https://github.com/elastic/kibana/tree/masternode_modules/elastic-apm-node/index.d.ts#L7"},"signature":["Agent"],"initialIsOpen":false}],"setup":{"id":"def-server.FleetSetupContract","type":"Type","label":"FleetSetupContract","description":[],"source":{"path":"x-pack/plugins/fleet/server/plugin.ts","lineNumber":117,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L117"},"signature":["void"],"lifecycle":"setup","initialIsOpen":true},"start":{"id":"def-server.FleetStartContract","type":"Interface","label":"FleetStartContract","description":["\nDescribes public Fleet plugin contract returned at the `startup` stage."],"children":[{"id":"def-server.FleetStartContract.esIndexPatternService","type":"Object","label":"esIndexPatternService","description":[],"source":{"path":"x-pack/plugins/fleet/server/plugin.ts","lineNumber":156,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L156"},"signature":[{"pluginId":"fleet","scope":"server","docId":"kibFleetPluginApi","section":"def-server.ESIndexPatternService","text":"ESIndexPatternService"}]},{"id":"def-server.FleetStartContract.packageService","type":"Object","label":"packageService","description":[],"source":{"path":"x-pack/plugins/fleet/server/plugin.ts","lineNumber":157,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L157"},"signature":[{"pluginId":"fleet","scope":"server","docId":"kibFleetPluginApi","section":"def-server.PackageService","text":"PackageService"}]},{"id":"def-server.FleetStartContract.agentService","type":"Object","label":"agentService","description":[],"source":{"path":"x-pack/plugins/fleet/server/plugin.ts","lineNumber":158,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L158"},"signature":[{"pluginId":"fleet","scope":"server","docId":"kibFleetPluginApi","section":"def-server.AgentService","text":"AgentService"}]},{"id":"def-server.FleetStartContract.packagePolicyService","type":"Object","label":"packagePolicyService","description":["\nServices for Fleet's package policies"],"source":{"path":"x-pack/plugins/fleet/server/plugin.ts","lineNumber":162,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L162"},"signature":[{"pluginId":"fleet","scope":"server","docId":"kibFleetPluginApi","section":"def-server.PackagePolicyService","text":"PackagePolicyService"}]},{"id":"def-server.FleetStartContract.agentPolicyService","type":"Object","label":"agentPolicyService","description":[],"source":{"path":"x-pack/plugins/fleet/server/plugin.ts","lineNumber":163,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L163"},"signature":[{"pluginId":"fleet","scope":"server","docId":"kibFleetPluginApi","section":"def-server.AgentPolicyServiceInterface","text":"AgentPolicyServiceInterface"}]},{"id":"def-server.FleetStartContract.registerExternalCallback","type":"Function","label":"registerExternalCallback","description":["\nRegister callbacks for inclusion in fleet API processing"],"source":{"path":"x-pack/plugins/fleet/server/plugin.ts","lineNumber":168,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L168"},"signature":["(...args: ",{"pluginId":"fleet","scope":"server","docId":"kibFleetPluginApi","section":"def-server.ExternalCallback","text":"ExternalCallback"},") => void"]}],"source":{"path":"x-pack/plugins/fleet/server/plugin.ts","lineNumber":155,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/server/plugin.ts#L155"},"lifecycle":"start","initialIsOpen":true}},"common":{"classes":[{"id":"def-common.LicenseService","type":"Class","label":"LicenseService","description":[],"children":[{"id":"def-common.LicenseService.start","type":"Function","label":"start","signature":["(license$: ","Observable","<",{"pluginId":"licensing","scope":"common","docId":"kibLicensingPluginApi","section":"def-common.ILicense","text":"ILicense"},">) => void"],"description":[],"children":[{"type":"Object","label":"license$","isRequired":true,"signature":["Observable","<",{"pluginId":"licensing","scope":"common","docId":"kibLicensingPluginApi","section":"def-common.ILicense","text":"ILicense"},">"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/license.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/license.ts#L22"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/fleet/common/services/license.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/license.ts#L22"}},{"id":"def-common.LicenseService.stop","type":"Function","label":"stop","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/fleet/common/services/license.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/license.ts#L27"}},{"id":"def-common.LicenseService.getLicenseInformation","type":"Function","label":"getLicenseInformation","signature":["() => ",{"pluginId":"licensing","scope":"common","docId":"kibLicensingPluginApi","section":"def-common.ILicense","text":"ILicense"}," | null"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/fleet/common/services/license.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/license.ts#L33"}},{"id":"def-common.LicenseService.getLicenseInformation$","type":"Function","label":"getLicenseInformation$","signature":["() => ","Observable","<",{"pluginId":"licensing","scope":"common","docId":"kibLicensingPluginApi","section":"def-common.ILicense","text":"ILicense"},"> | null"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/fleet/common/services/license.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/license.ts#L37"}},{"id":"def-common.LicenseService.isGoldPlus","type":"Function","label":"isGoldPlus","signature":["() => boolean | undefined"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/fleet/common/services/license.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/license.ts#L41"}},{"id":"def-common.LicenseService.isEnterprise","type":"Function","label":"isEnterprise","signature":["() => boolean | undefined"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/fleet/common/services/license.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/license.ts#L48"}}],"source":{"path":"x-pack/plugins/fleet/common/services/license.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/license.ts#L13"},"initialIsOpen":false}],"functions":[{"id":"def-common.packageToPackagePolicyInputs","type":"Function","children":[{"type":"CompoundType","label":"packageInfo","isRequired":true,"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.PackageInfo","text":"PackageInfo"}],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/package_to_package_policy.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/package_to_package_policy.ts#L47"}}],"signature":["(packageInfo: ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.PackageInfo","text":"PackageInfo"},") => ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.NewPackagePolicyInput","text":"NewPackagePolicyInput"},"[]"],"description":[],"label":"packageToPackagePolicyInputs","source":{"path":"x-pack/plugins/fleet/common/services/package_to_package_policy.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/package_to_package_policy.ts#L46"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.packageToPackagePolicy","type":"Function","children":[{"type":"CompoundType","label":"packageInfo","isRequired":true,"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.PackageInfo","text":"PackageInfo"}],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/package_to_package_policy.ts","lineNumber":117,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/package_to_package_policy.ts#L117"}},{"type":"string","label":"agentPolicyId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/package_to_package_policy.ts","lineNumber":118,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/package_to_package_policy.ts#L118"}},{"type":"string","label":"outputId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/package_to_package_policy.ts","lineNumber":119,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/package_to_package_policy.ts#L119"}},{"type":"string","label":"namespace","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/package_to_package_policy.ts","lineNumber":120,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/package_to_package_policy.ts#L120"}},{"type":"string","label":"packagePolicyName","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/package_to_package_policy.ts","lineNumber":121,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/package_to_package_policy.ts#L121"}},{"type":"string","label":"description","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/package_to_package_policy.ts","lineNumber":122,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/package_to_package_policy.ts#L122"}}],"signature":["(packageInfo: ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.PackageInfo","text":"PackageInfo"},", agentPolicyId: string, outputId: string, namespace?: string, packagePolicyName?: string | undefined, description?: string | undefined) => ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.NewPackagePolicy","text":"NewPackagePolicy"}],"description":["\nBuilds a `NewPackagePolicy` structure based on a package\n"],"label":"packageToPackagePolicy","source":{"path":"x-pack/plugins/fleet/common/services/package_to_package_policy.ts","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/package_to_package_policy.ts#L116"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.storedPackagePoliciesToAgentInputs","type":"Function","children":[{"type":"Array","label":"packagePolicies","isRequired":true,"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.PackagePolicy","text":"PackagePolicy"},"[]"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/package_policies_to_agent_inputs.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/package_policies_to_agent_inputs.ts#L12"}}],"signature":["(packagePolicies: ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.PackagePolicy","text":"PackagePolicy"},"[]) => ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.FullAgentPolicyInput","text":"FullAgentPolicyInput"},"[]"],"description":[],"label":"storedPackagePoliciesToAgentInputs","source":{"path":"x-pack/plugins/fleet/common/services/package_policies_to_agent_inputs.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/package_policies_to_agent_inputs.ts#L11"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.fullAgentPolicyToYaml","type":"Function","children":[{"type":"Object","label":"policy","isRequired":true,"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.FullAgentPolicy","text":"FullAgentPolicy"}],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/full_agent_policy_to_yaml.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/full_agent_policy_to_yaml.ts#L26"}}],"signature":["(policy: ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.FullAgentPolicy","text":"FullAgentPolicy"},") => string"],"description":[],"label":"fullAgentPolicyToYaml","source":{"path":"x-pack/plugins/fleet/common/services/full_agent_policy_to_yaml.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/full_agent_policy_to_yaml.ts#L26"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.isPackageLimited","type":"Function","children":[{"type":"CompoundType","label":"packageInfo","isRequired":true,"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.PackageInfo","text":"PackageInfo"}],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/limited_package.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/limited_package.ts#L11"}}],"signature":["(packageInfo: ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.PackageInfo","text":"PackageInfo"},") => boolean"],"description":[],"label":"isPackageLimited","source":{"path":"x-pack/plugins/fleet/common/services/limited_package.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/limited_package.ts#L11"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.doesAgentPolicyAlreadyIncludePackage","type":"Function","children":[{"type":"Object","label":"agentPolicy","isRequired":true,"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AgentPolicy","text":"AgentPolicy"}],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/limited_package.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/limited_package.ts#L16"}},{"type":"string","label":"packageName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/limited_package.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/limited_package.ts#L17"}}],"signature":["(agentPolicy: ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AgentPolicy","text":"AgentPolicy"},", packageName: string) => boolean"],"description":[],"label":"doesAgentPolicyAlreadyIncludePackage","source":{"path":"x-pack/plugins/fleet/common/services/limited_package.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/limited_package.ts#L15"},"returnComment":[],"initialIsOpen":false},{"id":"def-common.decodeCloudId","type":"Function","label":"decodeCloudId","signature":["(cid: string) => { host: string; defaultPort: string; elasticsearchUrl: string; kibanaUrl: string; } | undefined"],"description":[],"children":[{"type":"string","label":"cid","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/decode_cloud_id.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/decode_cloud_id.ts#L10"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/fleet/common/services/decode_cloud_id.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/decode_cloud_id.ts#L9"},"initialIsOpen":false},{"id":"def-common.isValidNamespace","type":"Function","label":"isValidNamespace","signature":["(namespace: string) => { valid: boolean; error?: string | undefined; }"],"description":[],"children":[{"type":"string","label":"namespace","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/is_valid_namespace.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/is_valid_namespace.ts#L13"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/fleet/common/services/is_valid_namespace.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/is_valid_namespace.ts#L13"},"initialIsOpen":false},{"id":"def-common.isDiffPathProtocol","type":"Function","label":"isDiffPathProtocol","signature":["(kibanaUrls: string[]) => boolean"],"description":[],"children":[{"type":"Array","label":"kibanaUrls","isRequired":true,"signature":["string[]"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/is_diff_path_protocol.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/is_diff_path_protocol.ts#L9"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/fleet/common/services/is_diff_path_protocol.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/is_diff_path_protocol.ts#L9"},"initialIsOpen":false},{"id":"def-common.isAgentUpgradeable","type":"Function","label":"isAgentUpgradeable","signature":["(agent: ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.Agent","text":"Agent"},", kibanaVersion: string) => boolean"],"description":[],"children":[{"type":"Object","label":"agent","isRequired":true,"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.Agent","text":"Agent"}],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/is_agent_upgradeable.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/is_agent_upgradeable.ts#L12"}},{"type":"string","label":"kibanaVersion","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/is_agent_upgradeable.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/is_agent_upgradeable.ts#L12"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/fleet/common/services/is_agent_upgradeable.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/is_agent_upgradeable.ts#L12"},"initialIsOpen":false},{"id":"def-common.entries","type":"Function","label":"entries","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/index.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/index.ts#L39"},"signature":["(o: T) => [keyof T, T[keyof T]][]"],"initialIsOpen":false}],"interfaces":[{"id":"def-common.FleetConfigType","type":"Interface","label":"FleetConfigType","description":[],"children":[{"id":"def-common.FleetConfigType.enabled","type":"boolean","label":"enabled","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/index.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/index.ts#L12"}},{"id":"def-common.FleetConfigType.registryUrl","type":"string","label":"registryUrl","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/index.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/index.ts#L13"},"signature":["string | undefined"]},{"id":"def-common.FleetConfigType.registryProxyUrl","type":"string","label":"registryProxyUrl","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/index.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/index.ts#L14"},"signature":["string | undefined"]},{"id":"def-common.FleetConfigType.agents","type":"Object","label":"agents","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/index.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/index.ts#L15"},"signature":["{ fleetServerEnabled: boolean; enabled: boolean; tlsCheckDisabled: boolean; pollingRequestTimeout: number; maxConcurrentConnections: number; kibana: { host?: string | string[] | undefined; ca_sha256?: string | undefined; }; elasticsearch: { host?: string | undefined; ca_sha256?: string | undefined; }; agentPolicyRolloutRateLimitIntervalMs: number; agentPolicyRolloutRateLimitRequestPerInterval: number; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/index.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/index.ts#L11"},"initialIsOpen":false},{"id":"def-common.NewAgentAction","type":"Interface","label":"NewAgentAction","description":[],"children":[{"id":"def-common.NewAgentAction.type","type":"CompoundType","label":"type","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L38"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AgentActionType","text":"AgentActionType"}]},{"id":"def-common.NewAgentAction.data","type":"Any","label":"data","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L39"},"signature":["any"]},{"id":"def-common.NewAgentAction.sent_at","type":"string","label":"sent_at","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L40"},"signature":["string | undefined"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L37"},"initialIsOpen":false},{"id":"def-common.AgentAction","type":"Interface","label":"AgentAction","signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AgentAction","text":"AgentAction"}," extends ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.NewAgentAction","text":"NewAgentAction"}],"description":[],"children":[{"id":"def-common.AgentAction.type","type":"CompoundType","label":"type","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L44"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AgentActionType","text":"AgentActionType"}]},{"id":"def-common.AgentAction.data","type":"Any","label":"data","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L45"},"signature":["any"]},{"id":"def-common.AgentAction.sent_at","type":"string","label":"sent_at","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L46"},"signature":["string | undefined"]},{"id":"def-common.AgentAction.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L47"}},{"id":"def-common.AgentAction.agent_id","type":"string","label":"agent_id","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L48"}},{"id":"def-common.AgentAction.created_at","type":"string","label":"created_at","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L49"}},{"id":"def-common.AgentAction.ack_data","type":"Any","label":"ack_data","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L50"},"signature":["any"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L43"},"initialIsOpen":false},{"id":"def-common.AgentPolicyAction","type":"Interface","label":"AgentPolicyAction","signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AgentPolicyAction","text":"AgentPolicyAction"}," extends ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.NewAgentAction","text":"NewAgentAction"}],"description":[],"children":[{"id":"def-common.AgentPolicyAction.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L54"}},{"id":"def-common.AgentPolicyAction.type","type":"CompoundType","label":"type","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L55"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AgentActionType","text":"AgentActionType"}]},{"id":"def-common.AgentPolicyAction.data","type":"Object","label":"data","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L56"},"signature":["{ policy: ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.FullAgentPolicy","text":"FullAgentPolicy"},"; }"]},{"id":"def-common.AgentPolicyAction.policy_id","type":"string","label":"policy_id","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L59"}},{"id":"def-common.AgentPolicyAction.policy_revision","type":"number","label":"policy_revision","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L60"}},{"id":"def-common.AgentPolicyAction.created_at","type":"string","label":"created_at","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L61"}},{"id":"def-common.AgentPolicyAction.ack_data","type":"Any","label":"ack_data","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L62"},"signature":["any"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L53"},"initialIsOpen":false},{"id":"def-common.NewAgentEvent","type":"Interface","label":"NewAgentEvent","description":[],"children":[{"id":"def-common.NewAgentEvent.type","type":"CompoundType","label":"type","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":93,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L93"},"signature":["\"STATE\" | \"ERROR\" | \"ACTION_RESULT\" | \"ACTION\""]},{"id":"def-common.NewAgentEvent.subtype","type":"CompoundType","label":"subtype","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L94"},"signature":["\"RUNNING\" | \"STARTING\" | \"IN_PROGRESS\" | \"CONFIG\" | \"FAILED\" | \"STOPPING\" | \"STOPPED\" | \"DEGRADED\" | \"UPDATING\" | \"DATA_DUMP\" | \"ACKNOWLEDGED\" | \"UNKNOWN\""]},{"id":"def-common.NewAgentEvent.timestamp","type":"string","label":"timestamp","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":109,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L109"}},{"id":"def-common.NewAgentEvent.message","type":"string","label":"message","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L110"}},{"id":"def-common.NewAgentEvent.payload","type":"Any","label":"payload","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":111,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L111"},"signature":["any"]},{"id":"def-common.NewAgentEvent.agent_id","type":"string","label":"agent_id","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":112,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L112"}},{"id":"def-common.NewAgentEvent.action_id","type":"string","label":"action_id","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":113,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L113"},"signature":["string | undefined"]},{"id":"def-common.NewAgentEvent.policy_id","type":"string","label":"policy_id","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":114,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L114"},"signature":["string | undefined"]},{"id":"def-common.NewAgentEvent.stream_id","type":"string","label":"stream_id","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L115"},"signature":["string | undefined"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L92"},"initialIsOpen":false},{"id":"def-common.AgentEvent","type":"Interface","label":"AgentEvent","signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AgentEvent","text":"AgentEvent"}," extends ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.NewAgentEvent","text":"NewAgentEvent"}],"description":[],"children":[{"id":"def-common.AgentEvent.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":119,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L119"}}],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":118,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L118"},"initialIsOpen":false},{"id":"def-common.AgentMetadata","type":"Interface","label":"AgentMetadata","description":[],"children":[{"id":"def-common.AgentMetadata.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":125,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L125"},"signature":["any"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":124,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L124"},"initialIsOpen":false},{"id":"def-common.Agent","type":"Interface","label":"Agent","signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.Agent","text":"Agent"}," extends AgentBase"],"description":[],"children":[{"id":"def-common.Agent.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":147,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L147"}},{"id":"def-common.Agent.current_error_events","type":"Array","label":"current_error_events","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":148,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L148"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AgentEvent","text":"AgentEvent"},"[]"]},{"id":"def-common.Agent.access_api_key","type":"string","label":"access_api_key","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":149,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L149"},"signature":["string | undefined"]},{"id":"def-common.Agent.status","type":"string","label":"status","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":150,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L150"},"signature":["string | undefined"]},{"id":"def-common.Agent.packages","type":"Array","label":"packages","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":151,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L151"},"signature":["string[]"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":146,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L146"},"initialIsOpen":false},{"id":"def-common.AgentSOAttributes","type":"Interface","label":"AgentSOAttributes","signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AgentSOAttributes","text":"AgentSOAttributes"}," extends AgentBase"],"description":[],"children":[{"id":"def-common.AgentSOAttributes.current_error_events","type":"string","label":"current_error_events","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":155,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L155"},"signature":["string | undefined"]},{"id":"def-common.AgentSOAttributes.packages","type":"Array","label":"packages","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":156,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L156"},"signature":["string[] | undefined"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":154,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L154"},"initialIsOpen":false},{"id":"def-common.FleetServerAgent","type":"Interface","label":"FleetServerAgent","description":["\nAn Elastic Agent that has enrolled into Fleet"],"children":[{"id":"def-common.FleetServerAgent._version","type":"number","label":"_version","description":["\nThe version of the document in the index"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":168,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L168"},"signature":["number | undefined"]},{"id":"def-common.FleetServerAgent.shared_id","type":"string","label":"shared_id","description":["\nShared ID"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":172,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L172"},"signature":["string | undefined"]},{"id":"def-common.FleetServerAgent.type","type":"CompoundType","label":"type","description":["\nType"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":176,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L176"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AgentType","text":"AgentType"}]},{"id":"def-common.FleetServerAgent.active","type":"boolean","label":"active","description":["\nActive flag"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":180,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L180"}},{"id":"def-common.FleetServerAgent.enrolled_at","type":"string","label":"enrolled_at","description":["\nDate/time the Elastic Agent enrolled"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":184,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L184"}},{"id":"def-common.FleetServerAgent.unenrolled_at","type":"string","label":"unenrolled_at","description":["\nDate/time the Elastic Agent unenrolled"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":188,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L188"},"signature":["string | undefined"]},{"id":"def-common.FleetServerAgent.unenrollment_started_at","type":"string","label":"unenrollment_started_at","description":["\nDate/time the Elastic Agent unenrolled started"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":192,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L192"},"signature":["string | undefined"]},{"id":"def-common.FleetServerAgent.upgraded_at","type":"CompoundType","label":"upgraded_at","description":["\nDate/time the Elastic Agent was last upgraded"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":196,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L196"},"signature":["string | null | undefined"]},{"id":"def-common.FleetServerAgent.upgrade_started_at","type":"CompoundType","label":"upgrade_started_at","description":["\nDate/time the Elastic Agent started the current upgrade"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":200,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L200"},"signature":["string | null | undefined"]},{"id":"def-common.FleetServerAgent.access_api_key_id","type":"string","label":"access_api_key_id","description":["\nID of the API key the Elastic Agent must used to contact Fleet Server"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":204,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L204"},"signature":["string | undefined"]},{"id":"def-common.FleetServerAgent.agent","type":"Object","label":"agent","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":205,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L205"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.FleetServerAgentMetadata","text":"FleetServerAgentMetadata"}," | undefined"]},{"id":"def-common.FleetServerAgent.user_provided_metadata","type":"Object","label":"user_provided_metadata","description":["\nUser provided metadata information for the Elastic Agent"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":209,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L209"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AgentMetadata","text":"AgentMetadata"}]},{"id":"def-common.FleetServerAgent.local_metadata","type":"Object","label":"local_metadata","description":["\nLocal metadata information for the Elastic Agent"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":213,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L213"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AgentMetadata","text":"AgentMetadata"}]},{"id":"def-common.FleetServerAgent.policy_id","type":"string","label":"policy_id","description":["\nThe policy ID for the Elastic Agent"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":217,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L217"},"signature":["string | undefined"]},{"id":"def-common.FleetServerAgent.policy_revision_idx","type":"CompoundType","label":"policy_revision_idx","description":["\nThe current policy revision_idx for the Elastic Agent"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":221,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L221"},"signature":["number | null | undefined"]},{"id":"def-common.FleetServerAgent.policy_coordinator_idx","type":"number","label":"policy_coordinator_idx","description":["\nThe current policy coordinator for the Elastic Agent"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":225,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L225"},"signature":["number | undefined"]},{"id":"def-common.FleetServerAgent.last_updated","type":"string","label":"last_updated","description":["\nDate/time the Elastic Agent was last updated"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":229,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L229"},"signature":["string | undefined"]},{"id":"def-common.FleetServerAgent.last_checkin","type":"string","label":"last_checkin","description":["\nDate/time the Elastic Agent checked in last time"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":233,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L233"},"signature":["string | undefined"]},{"id":"def-common.FleetServerAgent.last_checkin_status","type":"CompoundType","label":"last_checkin_status","description":["\nLst checkin status"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":237,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L237"},"signature":["\"online\" | \"error\" | \"updating\" | \"degraded\" | undefined"]},{"id":"def-common.FleetServerAgent.default_api_key_id","type":"string","label":"default_api_key_id","description":["\nID of the API key the Elastic Agent uses to authenticate with elasticsearch"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":241,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L241"},"signature":["string | undefined"]},{"id":"def-common.FleetServerAgent.default_api_key","type":"string","label":"default_api_key","description":["\nAPI key the Elastic Agent uses to authenticate with elasticsearch"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":245,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L245"},"signature":["string | undefined"]},{"id":"def-common.FleetServerAgent.updated_at","type":"string","label":"updated_at","description":["\nDate/time the Elastic Agent was last updated"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":249,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L249"},"signature":["string | undefined"]},{"id":"def-common.FleetServerAgent.packages","type":"Array","label":"packages","description":["\nPackages array"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":253,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L253"},"signature":["string[] | undefined"]},{"id":"def-common.FleetServerAgent.action_seq_no","type":"number","label":"action_seq_no","description":["\nThe last acknowledged action sequence number for the Elastic Agent"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":257,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L257"},"signature":["number | undefined"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":164,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L164"},"initialIsOpen":false},{"id":"def-common.FleetServerAgentMetadata","type":"Interface","label":"FleetServerAgentMetadata","description":["\nAn Elastic Agent metadata"],"children":[{"id":"def-common.FleetServerAgentMetadata.id","type":"string","label":"id","description":["\nThe unique identifier for the Elastic Agent"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":266,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L266"}},{"id":"def-common.FleetServerAgentMetadata.version","type":"string","label":"version","description":["\nThe version of the Elastic Agent"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":270,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L270"}},{"id":"def-common.FleetServerAgentMetadata.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":271,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L271"},"signature":["any"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":262,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L262"},"initialIsOpen":false},{"id":"def-common.FleetServerAgentAction","type":"Interface","label":"FleetServerAgentAction","description":["\nAn Elastic Agent action"],"children":[{"id":"def-common.FleetServerAgentAction._id","type":"string","label":"_id","description":["\nThe unique identifier for action document"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":281,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L281"},"signature":["string | undefined"]},{"id":"def-common.FleetServerAgentAction._seq_no","type":"number","label":"_seq_no","description":["\nThe action sequence number"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":285,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L285"},"signature":["number | undefined"]},{"id":"def-common.FleetServerAgentAction.action_id","type":"string","label":"action_id","description":["\nThe unique identifier for the Elastic Agent action. There could be multiple documents with the same action_id if the action is split into two separate documents."],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":289,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L289"},"signature":["string | undefined"]},{"id":"def-common.FleetServerAgentAction.'@timestamp'","type":"string","label":"'@timestamp'","description":["\nDate/time the action was created"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":293,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L293"},"signature":["string | undefined"]},{"id":"def-common.FleetServerAgentAction.expiration","type":"string","label":"expiration","description":["\nThe action expiration date/time"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":297,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L297"},"signature":["string | undefined"]},{"id":"def-common.FleetServerAgentAction.type","type":"string","label":"type","description":["\nThe action type. APP_ACTION is the value for the actions that suppose to be routed to the endpoints/beats."],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":301,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L301"},"signature":["string | undefined"]},{"id":"def-common.FleetServerAgentAction.input_id","type":"string","label":"input_id","description":["\nThe input identifier the actions should be routed to."],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":305,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L305"},"signature":["string | undefined"]},{"id":"def-common.FleetServerAgentAction.agents","type":"Array","label":"agents","description":["\nThe Agent IDs the action is intended for. No support for json.RawMessage with the current generator. Could be useful to lazy parse the agent ids"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":309,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L309"},"signature":["string[] | undefined"]},{"id":"def-common.FleetServerAgentAction.data","type":"Object","label":"data","description":["\nThe opaque payload."],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":313,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L313"},"signature":["{ [k: string]: unknown; } | undefined"]},{"id":"def-common.FleetServerAgentAction.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":316,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L316"},"signature":["any"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":277,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L277"},"initialIsOpen":false},{"id":"def-common.NewAgentPolicy","type":"Interface","label":"NewAgentPolicy","description":[],"children":[{"id":"def-common.NewAgentPolicy.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L16"}},{"id":"def-common.NewAgentPolicy.namespace","type":"string","label":"namespace","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L17"}},{"id":"def-common.NewAgentPolicy.description","type":"string","label":"description","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L18"},"signature":["string | undefined"]},{"id":"def-common.NewAgentPolicy.is_default","type":"CompoundType","label":"is_default","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L19"},"signature":["boolean | undefined"]},{"id":"def-common.NewAgentPolicy.is_default_fleet_server","type":"CompoundType","label":"is_default_fleet_server","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L20"},"signature":["boolean | undefined"]},{"id":"def-common.NewAgentPolicy.is_managed","type":"CompoundType","label":"is_managed","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L21"},"signature":["boolean | undefined"]},{"id":"def-common.NewAgentPolicy.monitoring_enabled","type":"Array","label":"monitoring_enabled","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L22"},"signature":["(\"metrics\" | \"logs\")[] | undefined"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L15"},"initialIsOpen":false},{"id":"def-common.AgentPolicy","type":"Interface","label":"AgentPolicy","signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AgentPolicy","text":"AgentPolicy"}," extends ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.NewAgentPolicy","text":"NewAgentPolicy"}],"description":[],"children":[{"id":"def-common.AgentPolicy.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L26"}},{"id":"def-common.AgentPolicy.status","type":"CompoundType","label":"status","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L27"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.ValueOf","text":"ValueOf"},"<{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }>"]},{"id":"def-common.AgentPolicy.package_policies","type":"CompoundType","label":"package_policies","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L28"},"signature":["string[] | ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.PackagePolicy","text":"PackagePolicy"},"[]"]},{"id":"def-common.AgentPolicy.is_managed","type":"boolean","label":"is_managed","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L29"}},{"id":"def-common.AgentPolicy.updated_at","type":"string","label":"updated_at","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L30"}},{"id":"def-common.AgentPolicy.updated_by","type":"string","label":"updated_by","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L31"}},{"id":"def-common.AgentPolicy.revision","type":"number","label":"revision","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L32"}}],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L25"},"initialIsOpen":false},{"id":"def-common.FullAgentPolicyInputStream","type":"Interface","label":"FullAgentPolicyInputStream","description":[],"children":[{"id":"def-common.FullAgentPolicyInputStream.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L38"}},{"id":"def-common.FullAgentPolicyInputStream.data_stream","type":"Object","label":"data_stream","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L39"},"signature":["{ dataset: string; type: string; }"]},{"id":"def-common.FullAgentPolicyInputStream.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L43"},"signature":["any"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L37"},"initialIsOpen":false},{"id":"def-common.FullAgentPolicyInput","type":"Interface","label":"FullAgentPolicyInput","description":[],"children":[{"id":"def-common.FullAgentPolicyInput.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L47"}},{"id":"def-common.FullAgentPolicyInput.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L48"}},{"id":"def-common.FullAgentPolicyInput.revision","type":"number","label":"revision","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L49"}},{"id":"def-common.FullAgentPolicyInput.type","type":"string","label":"type","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L50"}},{"id":"def-common.FullAgentPolicyInput.data_stream","type":"Object","label":"data_stream","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L51"},"signature":["{ namespace: string; }"]},{"id":"def-common.FullAgentPolicyInput.use_output","type":"string","label":"use_output","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L52"}},{"id":"def-common.FullAgentPolicyInput.meta","type":"Object","label":"meta","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L53"},"signature":["{ [key: string]: unknown; package?: Pick<",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.PackagePolicyPackage","text":"PackagePolicyPackage"},", \"name\" | \"version\"> | undefined; } | undefined"]},{"id":"def-common.FullAgentPolicyInput.streams","type":"Array","label":"streams","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L57"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.FullAgentPolicyInputStream","text":"FullAgentPolicyInputStream"},"[] | undefined"]},{"id":"def-common.FullAgentPolicyInput.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L58"},"signature":["any"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L46"},"initialIsOpen":false},{"id":"def-common.FullAgentPolicy","type":"Interface","label":"FullAgentPolicy","description":[],"children":[{"id":"def-common.FullAgentPolicy.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L62"}},{"id":"def-common.FullAgentPolicy.outputs","type":"Object","label":"outputs","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L63"},"signature":["{ [key: string]: Pick<",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.Output","text":"Output"},", \"type\" | \"hosts\" | \"ca_sha256\" | \"api_key\"> & { [key: string]: any; }; }"]},{"id":"def-common.FullAgentPolicy.fleet","type":"Object","label":"fleet","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L68"},"signature":["{ kibana: ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.FullAgentPolicyKibanaConfig","text":"FullAgentPolicyKibanaConfig"},"; } | undefined"]},{"id":"def-common.FullAgentPolicy.inputs","type":"Array","label":"inputs","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L71"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.FullAgentPolicyInput","text":"FullAgentPolicyInput"},"[]"]},{"id":"def-common.FullAgentPolicy.revision","type":"number","label":"revision","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L72"},"signature":["number | undefined"]},{"id":"def-common.FullAgentPolicy.agent","type":"Object","label":"agent","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L73"},"signature":["{ monitoring: { use_output?: string | undefined; enabled: boolean; metrics: boolean; logs: boolean; }; } | undefined"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L61"},"initialIsOpen":false},{"id":"def-common.FullAgentPolicyKibanaConfig","type":"Interface","label":"FullAgentPolicyKibanaConfig","description":[],"children":[{"id":"def-common.FullAgentPolicyKibanaConfig.hosts","type":"Array","label":"hosts","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L84"},"signature":["string[]"]},{"id":"def-common.FullAgentPolicyKibanaConfig.protocol","type":"string","label":"protocol","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":85,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L85"}},{"id":"def-common.FullAgentPolicyKibanaConfig.path","type":"string","label":"path","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L86"},"signature":["string | undefined"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L83"},"initialIsOpen":false},{"id":"def-common.FleetServerPolicy","type":"Interface","label":"FleetServerPolicy","description":["\nA policy that an Elastic Agent is attached to"],"children":[{"id":"def-common.FleetServerPolicy.'@timestamp'","type":"string","label":"'@timestamp'","description":["\nDate/time the policy revision was created"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L98"},"signature":["string | undefined"]},{"id":"def-common.FleetServerPolicy.policy_id","type":"string","label":"policy_id","description":["\nThe ID of the policy"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L102"}},{"id":"def-common.FleetServerPolicy.revision_idx","type":"number","label":"revision_idx","description":["\nThe revision index of the policy"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":106,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L106"}},{"id":"def-common.FleetServerPolicy.coordinator_idx","type":"number","label":"coordinator_idx","description":["\nThe coordinator index of the policy"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L110"}},{"id":"def-common.FleetServerPolicy.data","type":"Object","label":"data","description":["\nThe opaque payload."],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":114,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L114"},"signature":["{ [k: string]: unknown; }"]},{"id":"def-common.FleetServerPolicy.default_fleet_server","type":"boolean","label":"default_fleet_server","description":["\nTrue when this policy is the default policy to start Fleet Server"],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":120,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L120"}}],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L94"},"initialIsOpen":false},{"id":"def-common.PackagePolicyPackage","type":"Interface","label":"PackagePolicyPackage","description":[],"children":[{"id":"def-common.PackagePolicyPackage.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L9"}},{"id":"def-common.PackagePolicyPackage.title","type":"string","label":"title","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L10"}},{"id":"def-common.PackagePolicyPackage.version","type":"string","label":"version","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L11"}}],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L8"},"initialIsOpen":false},{"id":"def-common.PackagePolicyConfigRecordEntry","type":"Interface","label":"PackagePolicyConfigRecordEntry","description":[],"children":[{"id":"def-common.PackagePolicyConfigRecordEntry.type","type":"string","label":"type","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L15"},"signature":["string | undefined"]},{"id":"def-common.PackagePolicyConfigRecordEntry.value","type":"Any","label":"value","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L16"},"signature":["any"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L14"},"initialIsOpen":false},{"id":"def-common.NewPackagePolicyInputStream","type":"Interface","label":"NewPackagePolicyInputStream","description":[],"children":[{"id":"def-common.NewPackagePolicyInputStream.enabled","type":"boolean","label":"enabled","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L22"}},{"id":"def-common.NewPackagePolicyInputStream.data_stream","type":"Object","label":"data_stream","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L23"},"signature":["{ dataset: string; type: string; }"]},{"id":"def-common.NewPackagePolicyInputStream.vars","type":"Object","label":"vars","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L27"},"signature":["Record | undefined"]},{"id":"def-common.NewPackagePolicyInputStream.config","type":"Object","label":"config","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L28"},"signature":["Record | undefined"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L21"},"initialIsOpen":false},{"id":"def-common.PackagePolicyInputStream","type":"Interface","label":"PackagePolicyInputStream","signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.PackagePolicyInputStream","text":"PackagePolicyInputStream"}," extends ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.NewPackagePolicyInputStream","text":"NewPackagePolicyInputStream"}],"description":[],"children":[{"id":"def-common.PackagePolicyInputStream.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L32"}},{"id":"def-common.PackagePolicyInputStream.compiled_stream","type":"Any","label":"compiled_stream","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L33"},"signature":["any"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L31"},"initialIsOpen":false},{"id":"def-common.NewPackagePolicyInput","type":"Interface","label":"NewPackagePolicyInput","description":[],"children":[{"id":"def-common.NewPackagePolicyInput.type","type":"string","label":"type","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L37"}},{"id":"def-common.NewPackagePolicyInput.enabled","type":"boolean","label":"enabled","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L38"}},{"id":"def-common.NewPackagePolicyInput.vars","type":"Object","label":"vars","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L39"},"signature":["Record | undefined"]},{"id":"def-common.NewPackagePolicyInput.config","type":"Object","label":"config","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L40"},"signature":["Record | undefined"]},{"id":"def-common.NewPackagePolicyInput.streams","type":"Array","label":"streams","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L41"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.NewPackagePolicyInputStream","text":"NewPackagePolicyInputStream"},"[]"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L36"},"initialIsOpen":false},{"id":"def-common.PackagePolicyInput","type":"Interface","label":"PackagePolicyInput","signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.PackagePolicyInput","text":"PackagePolicyInput"}," extends Pick<",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.NewPackagePolicyInput","text":"NewPackagePolicyInput"},", \"type\" | \"enabled\" | \"config\" | \"vars\">"],"description":[],"children":[{"id":"def-common.PackagePolicyInput.streams","type":"Array","label":"streams","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L45"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.PackagePolicyInputStream","text":"PackagePolicyInputStream"},"[]"]},{"id":"def-common.PackagePolicyInput.compiled_input","type":"Any","label":"compiled_input","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L46"},"signature":["any"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L44"},"initialIsOpen":false},{"id":"def-common.NewPackagePolicy","type":"Interface","label":"NewPackagePolicy","description":[],"children":[{"id":"def-common.NewPackagePolicy.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L50"}},{"id":"def-common.NewPackagePolicy.description","type":"string","label":"description","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L51"},"signature":["string | undefined"]},{"id":"def-common.NewPackagePolicy.namespace","type":"string","label":"namespace","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L52"}},{"id":"def-common.NewPackagePolicy.enabled","type":"boolean","label":"enabled","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L53"}},{"id":"def-common.NewPackagePolicy.policy_id","type":"string","label":"policy_id","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L54"}},{"id":"def-common.NewPackagePolicy.output_id","type":"string","label":"output_id","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L55"}},{"id":"def-common.NewPackagePolicy.package","type":"Object","label":"package","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L56"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.PackagePolicyPackage","text":"PackagePolicyPackage"}," | undefined"]},{"id":"def-common.NewPackagePolicy.inputs","type":"Array","label":"inputs","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L57"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.NewPackagePolicyInput","text":"NewPackagePolicyInput"},"[]"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L49"},"initialIsOpen":false},{"id":"def-common.UpdatePackagePolicy","type":"Interface","label":"UpdatePackagePolicy","signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.UpdatePackagePolicy","text":"UpdatePackagePolicy"}," extends ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.NewPackagePolicy","text":"NewPackagePolicy"}],"description":[],"children":[{"id":"def-common.UpdatePackagePolicy.version","type":"string","label":"version","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L61"},"signature":["string | undefined"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L60"},"initialIsOpen":false},{"id":"def-common.PackagePolicy","type":"Interface","label":"PackagePolicy","signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.PackagePolicy","text":"PackagePolicy"}," extends Pick<",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.NewPackagePolicy","text":"NewPackagePolicy"},", \"enabled\" | \"description\" | \"name\" | \"package\" | \"namespace\" | \"policy_id\" | \"output_id\">"],"description":[],"children":[{"id":"def-common.PackagePolicy.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L65"}},{"id":"def-common.PackagePolicy.inputs","type":"Array","label":"inputs","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L66"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.PackagePolicyInput","text":"PackagePolicyInput"},"[]"]},{"id":"def-common.PackagePolicy.version","type":"string","label":"version","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L67"},"signature":["string | undefined"]},{"id":"def-common.PackagePolicy.revision","type":"number","label":"revision","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L68"}},{"id":"def-common.PackagePolicy.updated_at","type":"string","label":"updated_at","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L69"}},{"id":"def-common.PackagePolicy.updated_by","type":"string","label":"updated_by","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L70"}},{"id":"def-common.PackagePolicy.created_at","type":"string","label":"created_at","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L71"}},{"id":"def-common.PackagePolicy.created_by","type":"string","label":"created_by","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L72"}}],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L64"},"initialIsOpen":false},{"id":"def-common.DataStream","type":"Interface","label":"DataStream","description":[],"children":[{"id":"def-common.DataStream.index","type":"string","label":"index","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/data_stream.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/data_stream.ts#L9"}},{"id":"def-common.DataStream.dataset","type":"string","label":"dataset","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/data_stream.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/data_stream.ts#L10"}},{"id":"def-common.DataStream.namespace","type":"string","label":"namespace","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/data_stream.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/data_stream.ts#L11"}},{"id":"def-common.DataStream.type","type":"string","label":"type","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/data_stream.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/data_stream.ts#L12"}},{"id":"def-common.DataStream.package","type":"string","label":"package","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/data_stream.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/data_stream.ts#L13"}},{"id":"def-common.DataStream.package_version","type":"string","label":"package_version","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/data_stream.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/data_stream.ts#L14"}},{"id":"def-common.DataStream.last_activity_ms","type":"number","label":"last_activity_ms","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/data_stream.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/data_stream.ts#L15"}},{"id":"def-common.DataStream.size_in_bytes","type":"number","label":"size_in_bytes","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/data_stream.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/data_stream.ts#L16"}},{"id":"def-common.DataStream.dashboards","type":"Array","label":"dashboards","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/data_stream.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/data_stream.ts#L17"},"signature":["{ id: string; title: string; }[]"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/data_stream.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/data_stream.ts#L8"},"initialIsOpen":false},{"id":"def-common.NewOutput","type":"Interface","label":"NewOutput","description":[],"children":[{"id":"def-common.NewOutput.is_default","type":"boolean","label":"is_default","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/output.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/output.ts#L14"}},{"id":"def-common.NewOutput.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/output.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/output.ts#L15"}},{"id":"def-common.NewOutput.type","type":"string","label":"type","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/output.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/output.ts#L16"},"signature":["\"elasticsearch\""]},{"id":"def-common.NewOutput.hosts","type":"Array","label":"hosts","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/output.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/output.ts#L17"},"signature":["string[] | undefined"]},{"id":"def-common.NewOutput.ca_sha256","type":"string","label":"ca_sha256","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/output.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/output.ts#L18"},"signature":["string | undefined"]},{"id":"def-common.NewOutput.api_key","type":"string","label":"api_key","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/output.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/output.ts#L19"},"signature":["string | undefined"]},{"id":"def-common.NewOutput.fleet_enroll_username","type":"string","label":"fleet_enroll_username","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/output.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/output.ts#L20"},"signature":["string | undefined"]},{"id":"def-common.NewOutput.fleet_enroll_password","type":"string","label":"fleet_enroll_password","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/output.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/output.ts#L21"},"signature":["string | undefined"]},{"id":"def-common.NewOutput.config","type":"Object","label":"config","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/output.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/output.ts#L22"},"signature":["Record | undefined"]},{"id":"def-common.NewOutput.config_yaml","type":"string","label":"config_yaml","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/output.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/output.ts#L23"},"signature":["string | undefined"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/output.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/output.ts#L13"},"initialIsOpen":false},{"id":"def-common.RegistryImage","type":"Interface","label":"RegistryImage","description":[],"children":[{"id":"def-common.RegistryImage.src","type":"string","label":"src","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":111,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L111"}},{"id":"def-common.RegistryImage.path","type":"string","label":"path","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":112,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L112"}},{"id":"def-common.RegistryImage.title","type":"string","label":"title","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":113,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L113"},"signature":["string | undefined"]},{"id":"def-common.RegistryImage.size","type":"string","label":"size","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":114,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L114"},"signature":["string | undefined"]},{"id":"def-common.RegistryImage.type","type":"string","label":"type","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L115"},"signature":["string | undefined"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L110"},"initialIsOpen":false},{"id":"def-common.RegistryPolicyTemplate","type":"Interface","label":"RegistryPolicyTemplate","description":[],"children":[{"id":"def-common.RegistryPolicyTemplate.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":119,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L119"}},{"id":"def-common.RegistryPolicyTemplate.title","type":"string","label":"title","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":120,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L120"}},{"id":"def-common.RegistryPolicyTemplate.description","type":"string","label":"description","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":121,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L121"}},{"id":"def-common.RegistryPolicyTemplate.inputs","type":"Array","label":"inputs","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":122,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L122"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.RegistryInput","text":"RegistryInput"},"[] | undefined"]},{"id":"def-common.RegistryPolicyTemplate.multiple","type":"CompoundType","label":"multiple","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":123,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L123"},"signature":["boolean | undefined"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":118,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L118"},"initialIsOpen":false},{"id":"def-common.RegistryInput","type":"Interface","label":"RegistryInput","description":[],"children":[{"id":"def-common.RegistryInput.type","type":"string","label":"type","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":126,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L126"}},{"id":"def-common.RegistryInput.title","type":"string","label":"title","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":127,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L127"}},{"id":"def-common.RegistryInput.description","type":"string","label":"description","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":128,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L128"}},{"id":"def-common.RegistryInput.template_path","type":"string","label":"template_path","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":129,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L129"},"signature":["string | undefined"]},{"id":"def-common.RegistryInput.condition","type":"string","label":"condition","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":130,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L130"},"signature":["string | undefined"]},{"id":"def-common.RegistryInput.vars","type":"Array","label":"vars","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L131"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.RegistryVarsEntry","text":"RegistryVarsEntry"},"[] | undefined"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":125,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L125"},"initialIsOpen":false},{"id":"def-common.RegistryStream","type":"Interface","label":"RegistryStream","description":[],"children":[{"id":"def-common.RegistryStream.input","type":"string","label":"input","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":134,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L134"}},{"id":"def-common.RegistryStream.title","type":"string","label":"title","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":135,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L135"}},{"id":"def-common.RegistryStream.description","type":"string","label":"description","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":136,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L136"},"signature":["string | undefined"]},{"id":"def-common.RegistryStream.enabled","type":"CompoundType","label":"enabled","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":137,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L137"},"signature":["boolean | undefined"]},{"id":"def-common.RegistryStream.vars","type":"Array","label":"vars","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":138,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L138"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.RegistryVarsEntry","text":"RegistryVarsEntry"},"[] | undefined"]},{"id":"def-common.RegistryStream.template_path","type":"string","label":"template_path","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":139,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L139"}}],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":133,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L133"},"initialIsOpen":false},{"id":"def-common.ServiceRequirements","type":"Interface","label":"ServiceRequirements","description":[],"children":[{"id":"def-common.ServiceRequirements.versions","type":"string","label":"versions","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":145,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L145"}}],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":144,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L144"},"initialIsOpen":false},{"id":"def-common.CategorySummaryItem","type":"Interface","label":"CategorySummaryItem","description":[],"children":[{"id":"def-common.CategorySummaryItem.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":176,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L176"}},{"id":"def-common.CategorySummaryItem.title","type":"string","label":"title","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":177,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L177"}},{"id":"def-common.CategorySummaryItem.count","type":"number","label":"count","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":178,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L178"}}],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":175,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L175"},"initialIsOpen":false},{"id":"def-common.AssetParts","type":"Interface","label":"AssetParts","description":[],"children":[{"id":"def-common.AssetParts.pkgkey","type":"string","label":"pkgkey","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":183,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L183"}},{"id":"def-common.AssetParts.dataset","type":"string","label":"dataset","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":184,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L184"},"signature":["string | undefined"]},{"id":"def-common.AssetParts.service","type":"CompoundType","label":"service","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":185,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L185"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.ServiceName","text":"ServiceName"}]},{"id":"def-common.AssetParts.type","type":"CompoundType","label":"type","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":186,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L186"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AssetType","text":"AssetType"}]},{"id":"def-common.AssetParts.file","type":"string","label":"file","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":187,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L187"}}],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":182,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L182"},"initialIsOpen":false},{"id":"def-common.RegistryDataStream","type":"Interface","label":"RegistryDataStream","description":[],"children":[{"id":"def-common.RegistryDataStream.type","type":"string","label":"type","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":213,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L213"}},{"id":"def-common.RegistryDataStream.ilm_policy","type":"string","label":"ilm_policy","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":214,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L214"},"signature":["string | undefined"]},{"id":"def-common.RegistryDataStream.hidden","type":"CompoundType","label":"hidden","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":215,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L215"},"signature":["boolean | undefined"]},{"id":"def-common.RegistryDataStream.dataset","type":"string","label":"dataset","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":216,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L216"}},{"id":"def-common.RegistryDataStream.title","type":"string","label":"title","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":217,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L217"}},{"id":"def-common.RegistryDataStream.release","type":"string","label":"release","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":218,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L218"}},{"id":"def-common.RegistryDataStream.streams","type":"Array","label":"streams","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":219,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L219"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.RegistryStream","text":"RegistryStream"},"[] | undefined"]},{"id":"def-common.RegistryDataStream.package","type":"string","label":"package","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":220,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L220"}},{"id":"def-common.RegistryDataStream.path","type":"string","label":"path","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":221,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L221"}},{"id":"def-common.RegistryDataStream.ingest_pipeline","type":"string","label":"ingest_pipeline","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":222,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L222"}},{"id":"def-common.RegistryDataStream.elasticsearch","type":"Object","label":"elasticsearch","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":223,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L223"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.RegistryElasticsearch","text":"RegistryElasticsearch"}," | undefined"]},{"id":"def-common.RegistryDataStream.dataset_is_prefix","type":"CompoundType","label":"dataset_is_prefix","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":224,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L224"},"signature":["boolean | undefined"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":212,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L212"},"initialIsOpen":false},{"id":"def-common.RegistryElasticsearch","type":"Interface","label":"RegistryElasticsearch","description":[],"children":[{"id":"def-common.RegistryElasticsearch.'index_template.settings'","type":"Uncategorized","label":"'index_template.settings'","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":228,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L228"},"signature":["object | undefined"]},{"id":"def-common.RegistryElasticsearch.'index_template.mappings'","type":"Uncategorized","label":"'index_template.mappings'","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":229,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L229"},"signature":["object | undefined"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":227,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L227"},"initialIsOpen":false},{"id":"def-common.RegistryVarsEntry","type":"Interface","label":"RegistryVarsEntry","description":[],"children":[{"id":"def-common.RegistryVarsEntry.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":237,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L237"}},{"id":"def-common.RegistryVarsEntry.title","type":"string","label":"title","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":238,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L238"},"signature":["string | undefined"]},{"id":"def-common.RegistryVarsEntry.description","type":"string","label":"description","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":239,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L239"},"signature":["string | undefined"]},{"id":"def-common.RegistryVarsEntry.type","type":"CompoundType","label":"type","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":240,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L240"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.RegistryVarType","text":"RegistryVarType"}]},{"id":"def-common.RegistryVarsEntry.required","type":"CompoundType","label":"required","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":241,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L241"},"signature":["boolean | undefined"]},{"id":"def-common.RegistryVarsEntry.show_user","type":"CompoundType","label":"show_user","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":242,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L242"},"signature":["boolean | undefined"]},{"id":"def-common.RegistryVarsEntry.multi","type":"CompoundType","label":"multi","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":243,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L243"},"signature":["boolean | undefined"]},{"id":"def-common.RegistryVarsEntry.default","type":"CompoundType","label":"default","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":244,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L244"},"signature":["string | string[] | undefined"]},{"id":"def-common.RegistryVarsEntry.os","type":"Object","label":"os","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":245,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L245"},"signature":["{ [key: string]: { default: string | string[]; }; } | undefined"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":236,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L236"},"initialIsOpen":false},{"id":"def-common.EpmPackageAdditions","type":"Interface","label":"EpmPackageAdditions","description":[],"children":[{"id":"def-common.EpmPackageAdditions.title","type":"string","label":"title","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":255,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L255"}},{"id":"def-common.EpmPackageAdditions.latestVersion","type":"string","label":"latestVersion","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":256,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L256"}},{"id":"def-common.EpmPackageAdditions.assets","type":"CompoundType","label":"assets","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":257,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L257"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AssetsGroupedByServiceByType","text":"AssetsGroupedByServiceByType"}]},{"id":"def-common.EpmPackageAdditions.removable","type":"CompoundType","label":"removable","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":258,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L258"},"signature":["boolean | undefined"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":254,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L254"},"initialIsOpen":false},{"id":"def-common.Installation","type":"Interface","label":"Installation","signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.Installation","text":"Installation"}," extends ","SavedObjectAttributes"],"description":[],"children":[{"id":"def-common.Installation.installed_kibana","type":"Array","label":"installed_kibana","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":274,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L274"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.KibanaAssetReference","text":"KibanaAssetReference"},"[]"]},{"id":"def-common.Installation.installed_es","type":"Array","label":"installed_es","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":275,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L275"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.EsAssetReference","text":"EsAssetReference"},"[]"]},{"id":"def-common.Installation.package_assets","type":"Array","label":"package_assets","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":276,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L276"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.PackageAssetReference","text":"PackageAssetReference"},"[] | undefined"]},{"id":"def-common.Installation.es_index_patterns","type":"Object","label":"es_index_patterns","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":277,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L277"},"signature":["Record"]},{"id":"def-common.Installation.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":278,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L278"}},{"id":"def-common.Installation.version","type":"string","label":"version","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":279,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L279"}},{"id":"def-common.Installation.install_status","type":"CompoundType","label":"install_status","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":280,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L280"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.EpmPackageInstallStatus","text":"EpmPackageInstallStatus"}]},{"id":"def-common.Installation.install_version","type":"string","label":"install_version","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":281,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L281"}},{"id":"def-common.Installation.install_started_at","type":"string","label":"install_started_at","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":282,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L282"}},{"id":"def-common.Installation.install_source","type":"CompoundType","label":"install_source","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":283,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L283"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.InstallSource","text":"InstallSource"}]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":273,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L273"},"initialIsOpen":false},{"id":"def-common.PackageUsageStats","type":"Interface","label":"PackageUsageStats","description":[],"children":[{"id":"def-common.PackageUsageStats.agent_policy_count","type":"number","label":"agent_policy_count","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":287,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L287"}}],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":286,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L286"},"initialIsOpen":false},{"id":"def-common.IndexTemplateMappings","type":"Interface","label":"IndexTemplateMappings","description":[],"children":[{"id":"def-common.IndexTemplateMappings.properties","type":"Any","label":"properties","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":319,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L319"},"signature":["any"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":318,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L318"},"initialIsOpen":false},{"id":"def-common.IndexTemplate","type":"Interface","label":"IndexTemplate","description":[],"children":[{"id":"def-common.IndexTemplate.priority","type":"number","label":"priority","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":326,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L326"}},{"id":"def-common.IndexTemplate.index_patterns","type":"Array","label":"index_patterns","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":327,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L327"},"signature":["string[]"]},{"id":"def-common.IndexTemplate.template","type":"Object","label":"template","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":328,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L328"},"signature":["{ settings: any; mappings: any; }"]},{"id":"def-common.IndexTemplate.data_stream","type":"Object","label":"data_stream","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":332,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L332"},"signature":["{ hidden?: boolean | undefined; }"]},{"id":"def-common.IndexTemplate.composed_of","type":"Array","label":"composed_of","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":333,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L333"},"signature":["string[]"]},{"id":"def-common.IndexTemplate._meta","type":"Uncategorized","label":"_meta","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":334,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L334"},"signature":["object"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":325,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L325"},"initialIsOpen":false},{"id":"def-common.TemplateRef","type":"Interface","label":"TemplateRef","description":[],"children":[{"id":"def-common.TemplateRef.templateName","type":"string","label":"templateName","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":338,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L338"}},{"id":"def-common.TemplateRef.indexTemplate","type":"Object","label":"indexTemplate","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":339,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L339"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.IndexTemplate","text":"IndexTemplate"}]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":337,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L337"},"initialIsOpen":false},{"id":"def-common.PackageSpecManifest","type":"Interface","label":"PackageSpecManifest","description":[],"children":[{"id":"def-common.PackageSpecManifest.format_version","type":"string","label":"format_version","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_spec.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L12"}},{"id":"def-common.PackageSpecManifest.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_spec.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L13"}},{"id":"def-common.PackageSpecManifest.title","type":"string","label":"title","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_spec.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L14"}},{"id":"def-common.PackageSpecManifest.description","type":"string","label":"description","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_spec.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L15"}},{"id":"def-common.PackageSpecManifest.version","type":"string","label":"version","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_spec.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L16"}},{"id":"def-common.PackageSpecManifest.license","type":"string","label":"license","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_spec.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L17"},"signature":["\"basic\" | undefined"]},{"id":"def-common.PackageSpecManifest.type","type":"string","label":"type","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_spec.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L18"},"signature":["\"integration\" | undefined"]},{"id":"def-common.PackageSpecManifest.release","type":"CompoundType","label":"release","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_spec.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L19"},"signature":["\"experimental\" | \"beta\" | \"ga\""]},{"id":"def-common.PackageSpecManifest.categories","type":"Array","label":"categories","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_spec.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L20"},"signature":["(\"custom\" | \"security\" | \"monitoring\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\" | undefined)[] | undefined"]},{"id":"def-common.PackageSpecManifest.conditions","type":"Object","label":"conditions","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_spec.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L21"},"signature":["Record<\"kibana\", { version: string; }> | undefined"]},{"id":"def-common.PackageSpecManifest.icons","type":"Array","label":"icons","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_spec.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L22"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.PackageSpecIcon","text":"PackageSpecIcon"},"[] | undefined"]},{"id":"def-common.PackageSpecManifest.screenshots","type":"Array","label":"screenshots","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_spec.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L23"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.PackageSpecScreenshot","text":"PackageSpecScreenshot"},"[] | undefined"]},{"id":"def-common.PackageSpecManifest.policy_templates","type":"Array","label":"policy_templates","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_spec.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L24"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.RegistryPolicyTemplate","text":"RegistryPolicyTemplate"},"[] | undefined"]},{"id":"def-common.PackageSpecManifest.owner","type":"Object","label":"owner","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_spec.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L25"},"signature":["{ github: string; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_spec.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L11"},"initialIsOpen":false},{"id":"def-common.PackageSpecIcon","type":"Interface","label":"PackageSpecIcon","description":[],"children":[{"id":"def-common.PackageSpecIcon.src","type":"string","label":"src","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_spec.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L61"}},{"id":"def-common.PackageSpecIcon.title","type":"string","label":"title","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_spec.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L62"},"signature":["string | undefined"]},{"id":"def-common.PackageSpecIcon.size","type":"string","label":"size","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_spec.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L63"},"signature":["string | undefined"]},{"id":"def-common.PackageSpecIcon.type","type":"string","label":"type","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_spec.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L64"},"signature":["string | undefined"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_spec.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L60"},"initialIsOpen":false},{"id":"def-common.PackageSpecScreenshot","type":"Interface","label":"PackageSpecScreenshot","description":[],"children":[{"id":"def-common.PackageSpecScreenshot.src","type":"string","label":"src","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_spec.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L68"}},{"id":"def-common.PackageSpecScreenshot.title","type":"string","label":"title","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_spec.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L69"}},{"id":"def-common.PackageSpecScreenshot.size","type":"string","label":"size","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_spec.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L70"},"signature":["string | undefined"]},{"id":"def-common.PackageSpecScreenshot.type","type":"string","label":"type","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_spec.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L71"},"signature":["string | undefined"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_spec.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L67"},"initialIsOpen":false},{"id":"def-common.EnrollmentAPIKey","type":"Interface","label":"EnrollmentAPIKey","description":[],"children":[{"id":"def-common.EnrollmentAPIKey.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L9"}},{"id":"def-common.EnrollmentAPIKey.api_key_id","type":"string","label":"api_key_id","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L10"}},{"id":"def-common.EnrollmentAPIKey.api_key","type":"string","label":"api_key","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L11"}},{"id":"def-common.EnrollmentAPIKey.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L12"},"signature":["string | undefined"]},{"id":"def-common.EnrollmentAPIKey.active","type":"boolean","label":"active","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L13"}},{"id":"def-common.EnrollmentAPIKey.policy_id","type":"string","label":"policy_id","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L14"},"signature":["string | undefined"]},{"id":"def-common.EnrollmentAPIKey.created_at","type":"string","label":"created_at","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L15"}}],"source":{"path":"x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L8"},"initialIsOpen":false},{"id":"def-common.FleetServerEnrollmentAPIKey","type":"Interface","label":"FleetServerEnrollmentAPIKey","description":["\nAn Elastic Agent enrollment API key"],"children":[{"id":"def-common.FleetServerEnrollmentAPIKey.active","type":"CompoundType","label":"active","description":["\nTrue when the key is active"],"source":{"path":"x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L29"},"signature":["boolean | undefined"]},{"id":"def-common.FleetServerEnrollmentAPIKey.api_key_id","type":"string","label":"api_key_id","description":["\nThe unique identifier for the enrollment key, currently xid"],"source":{"path":"x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L33"}},{"id":"def-common.FleetServerEnrollmentAPIKey.api_key","type":"string","label":"api_key","description":["\nApi key"],"source":{"path":"x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L37"}},{"id":"def-common.FleetServerEnrollmentAPIKey.name","type":"string","label":"name","description":["\nEnrollment key name"],"source":{"path":"x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L41"},"signature":["string | undefined"]},{"id":"def-common.FleetServerEnrollmentAPIKey.policy_id","type":"string","label":"policy_id","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L42"},"signature":["string | undefined"]},{"id":"def-common.FleetServerEnrollmentAPIKey.expire_at","type":"string","label":"expire_at","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L43"},"signature":["string | undefined"]},{"id":"def-common.FleetServerEnrollmentAPIKey.created_at","type":"string","label":"created_at","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L44"},"signature":["string | undefined"]},{"id":"def-common.FleetServerEnrollmentAPIKey.updated_at","type":"string","label":"updated_at","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L45"},"signature":["string | undefined"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L25"},"initialIsOpen":false},{"id":"def-common.BaseSettings","type":"Interface","label":"BaseSettings","description":[],"children":[{"id":"def-common.BaseSettings.agent_auto_upgrade","type":"boolean","label":"agent_auto_upgrade","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/settings.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/settings.ts#L11"}},{"id":"def-common.BaseSettings.package_auto_upgrade","type":"boolean","label":"package_auto_upgrade","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/settings.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/settings.ts#L12"}},{"id":"def-common.BaseSettings.kibana_urls","type":"Array","label":"kibana_urls","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/settings.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/settings.ts#L13"},"signature":["string[]"]},{"id":"def-common.BaseSettings.kibana_ca_sha256","type":"string","label":"kibana_ca_sha256","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/settings.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/settings.ts#L14"},"signature":["string | undefined"]},{"id":"def-common.BaseSettings.has_seen_add_data_notice","type":"CompoundType","label":"has_seen_add_data_notice","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/settings.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/settings.ts#L15"},"signature":["boolean | undefined"]}],"source":{"path":"x-pack/plugins/fleet/common/types/models/settings.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/settings.ts#L10"},"initialIsOpen":false},{"id":"def-common.Settings","type":"Interface","label":"Settings","signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.Settings","text":"Settings"}," extends ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.BaseSettings","text":"BaseSettings"}],"description":[],"children":[{"id":"def-common.Settings.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/settings.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/settings.ts#L19"}}],"source":{"path":"x-pack/plugins/fleet/common/types/models/settings.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/settings.ts#L18"},"initialIsOpen":false},{"id":"def-common.SettingsSOAttributes","type":"Interface","label":"SettingsSOAttributes","signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.SettingsSOAttributes","text":"SettingsSOAttributes"}," extends ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.BaseSettings","text":"BaseSettings"},",","SavedObjectAttributes"],"description":[],"children":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/settings.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/settings.ts#L22"},"initialIsOpen":false},{"id":"def-common.ListWithKuery","type":"Interface","label":"ListWithKuery","signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.ListWithKuery","text":"ListWithKuery"}," extends ",{"pluginId":"core","scope":"public","docId":"kibCoreHttpPluginApi","section":"def-public.HttpFetchQuery","text":"HttpFetchQuery"}],"description":[],"children":[{"id":"def-common.ListWithKuery.page","type":"number","label":"page","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/common.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/common.ts#L11"},"signature":["number | undefined"]},{"id":"def-common.ListWithKuery.perPage","type":"number","label":"perPage","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/common.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/common.ts#L12"},"signature":["number | undefined"]},{"id":"def-common.ListWithKuery.sortField","type":"string","label":"sortField","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/common.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/common.ts#L13"},"signature":["string | undefined"]},{"id":"def-common.ListWithKuery.sortOrder","type":"CompoundType","label":"sortOrder","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/common.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/common.ts#L14"},"signature":["\"asc\" | \"desc\" | undefined"]},{"id":"def-common.ListWithKuery.kuery","type":"string","label":"kuery","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/common.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/common.ts#L15"},"signature":["string | undefined"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/common.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/common.ts#L10"},"initialIsOpen":false},{"id":"def-common.ListResult","type":"Interface","label":"ListResult","signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.ListResult","text":"ListResult"},""],"description":[],"children":[{"id":"def-common.ListResult.items","type":"Array","label":"items","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/common.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/common.ts#L19"},"signature":["T[]"]},{"id":"def-common.ListResult.total","type":"number","label":"total","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/common.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/common.ts#L20"}},{"id":"def-common.ListResult.page","type":"number","label":"page","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/common.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/common.ts#L21"}},{"id":"def-common.ListResult.perPage","type":"number","label":"perPage","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/common.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/common.ts#L22"}}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/common.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/common.ts#L18"},"initialIsOpen":false},{"id":"def-common.GetPackagePoliciesRequest","type":"Interface","label":"GetPackagePoliciesRequest","description":[],"children":[{"id":"def-common.GetPackagePoliciesRequest.query","type":"Object","label":"query","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L11"},"signature":["{ page: number; perPage: number; kuery?: string | undefined; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L10"},"initialIsOpen":false},{"id":"def-common.GetPackagePoliciesResponse","type":"Interface","label":"GetPackagePoliciesResponse","description":[],"children":[{"id":"def-common.GetPackagePoliciesResponse.items","type":"Array","label":"items","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L19"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.PackagePolicy","text":"PackagePolicy"},"[]"]},{"id":"def-common.GetPackagePoliciesResponse.total","type":"number","label":"total","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L20"}},{"id":"def-common.GetPackagePoliciesResponse.page","type":"number","label":"page","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L21"}},{"id":"def-common.GetPackagePoliciesResponse.perPage","type":"number","label":"perPage","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L22"}}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L18"},"initialIsOpen":false},{"id":"def-common.GetOnePackagePolicyRequest","type":"Interface","label":"GetOnePackagePolicyRequest","description":[],"children":[{"id":"def-common.GetOnePackagePolicyRequest.params","type":"Object","label":"params","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L26"},"signature":["{ packagePolicyId: string; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L25"},"initialIsOpen":false},{"id":"def-common.GetOnePackagePolicyResponse","type":"Interface","label":"GetOnePackagePolicyResponse","description":[],"children":[{"id":"def-common.GetOnePackagePolicyResponse.item","type":"Object","label":"item","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L32"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.PackagePolicy","text":"PackagePolicy"}]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L31"},"initialIsOpen":false},{"id":"def-common.CreatePackagePolicyRequest","type":"Interface","label":"CreatePackagePolicyRequest","description":[],"children":[{"id":"def-common.CreatePackagePolicyRequest.body","type":"Object","label":"body","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L36"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.NewPackagePolicy","text":"NewPackagePolicy"}]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L35"},"initialIsOpen":false},{"id":"def-common.CreatePackagePolicyResponse","type":"Interface","label":"CreatePackagePolicyResponse","description":[],"children":[{"id":"def-common.CreatePackagePolicyResponse.item","type":"Object","label":"item","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L40"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.PackagePolicy","text":"PackagePolicy"}]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L39"},"initialIsOpen":false},{"id":"def-common.DeletePackagePoliciesRequest","type":"Interface","label":"DeletePackagePoliciesRequest","description":[],"children":[{"id":"def-common.DeletePackagePoliciesRequest.body","type":"Object","label":"body","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L50"},"signature":["{ packagePolicyIds: string[]; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L49"},"initialIsOpen":false},{"id":"def-common.GetDataStreamsResponse","type":"Interface","label":"GetDataStreamsResponse","description":[],"children":[{"id":"def-common.GetDataStreamsResponse.data_streams","type":"Array","label":"data_streams","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/data_stream.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/data_stream.ts#L11"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.DataStream","text":"DataStream"},"[]"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/data_stream.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/data_stream.ts#L10"},"initialIsOpen":false},{"id":"def-common.GetAgentsRequest","type":"Interface","label":"GetAgentsRequest","description":[],"children":[{"id":"def-common.GetAgentsRequest.query","type":"Object","label":"query","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L19"},"signature":["{ page: number; perPage: number; kuery?: string | undefined; showInactive: boolean; showUpgradeable?: boolean | undefined; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L18"},"initialIsOpen":false},{"id":"def-common.GetAgentsResponse","type":"Interface","label":"GetAgentsResponse","description":[],"children":[{"id":"def-common.GetAgentsResponse.list","type":"Array","label":"list","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L29"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.Agent","text":"Agent"},"[]"]},{"id":"def-common.GetAgentsResponse.total","type":"number","label":"total","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L30"}},{"id":"def-common.GetAgentsResponse.totalInactive","type":"number","label":"totalInactive","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L31"}},{"id":"def-common.GetAgentsResponse.page","type":"number","label":"page","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L32"}},{"id":"def-common.GetAgentsResponse.perPage","type":"number","label":"perPage","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L33"}}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L28"},"initialIsOpen":false},{"id":"def-common.GetOneAgentRequest","type":"Interface","label":"GetOneAgentRequest","description":[],"children":[{"id":"def-common.GetOneAgentRequest.params","type":"Object","label":"params","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L37"},"signature":["{ agentId: string; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L36"},"initialIsOpen":false},{"id":"def-common.GetOneAgentResponse","type":"Interface","label":"GetOneAgentResponse","description":[],"children":[{"id":"def-common.GetOneAgentResponse.item","type":"Object","label":"item","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L43"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.Agent","text":"Agent"}]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L42"},"initialIsOpen":false},{"id":"def-common.PostAgentCheckinRequest","type":"Interface","label":"PostAgentCheckinRequest","description":[],"children":[{"id":"def-common.PostAgentCheckinRequest.params","type":"Object","label":"params","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L47"},"signature":["{ agentId: string; }"]},{"id":"def-common.PostAgentCheckinRequest.body","type":"Object","label":"body","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L50"},"signature":["{ status?: \"online\" | \"error\" | \"degraded\" | undefined; local_metadata?: Record | undefined; events?: ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.NewAgentEvent","text":"NewAgentEvent"},"[] | undefined; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L46"},"initialIsOpen":false},{"id":"def-common.PostAgentCheckinResponse","type":"Interface","label":"PostAgentCheckinResponse","description":[],"children":[{"id":"def-common.PostAgentCheckinResponse.action","type":"string","label":"action","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L58"}},{"id":"def-common.PostAgentCheckinResponse.actions","type":"Array","label":"actions","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L60"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AgentAction","text":"AgentAction"},"[]"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L57"},"initialIsOpen":false},{"id":"def-common.PostAgentEnrollRequest","type":"Interface","label":"PostAgentEnrollRequest","description":[],"children":[{"id":"def-common.PostAgentEnrollRequest.body","type":"Object","label":"body","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L64"},"signature":["{ type: ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AgentType","text":"AgentType"},"; metadata: { local: Record; user_provided: Record; }; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L63"},"initialIsOpen":false},{"id":"def-common.PostAgentEnrollResponse","type":"Interface","label":"PostAgentEnrollResponse","description":[],"children":[{"id":"def-common.PostAgentEnrollResponse.action","type":"string","label":"action","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L74"}},{"id":"def-common.PostAgentEnrollResponse.item","type":"CompoundType","label":"item","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":76,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L76"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.Agent","text":"Agent"}," & { status: ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AgentStatus","text":"AgentStatus"},"; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L73"},"initialIsOpen":false},{"id":"def-common.PostAgentAcksRequest","type":"Interface","label":"PostAgentAcksRequest","description":[],"children":[{"id":"def-common.PostAgentAcksRequest.body","type":"Object","label":"body","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L80"},"signature":["{ events: ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AgentEvent","text":"AgentEvent"},"[]; }"]},{"id":"def-common.PostAgentAcksRequest.params","type":"Object","label":"params","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L83"},"signature":["{ agentId: string; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L79"},"initialIsOpen":false},{"id":"def-common.PostAgentAcksResponse","type":"Interface","label":"PostAgentAcksResponse","description":[],"children":[{"id":"def-common.PostAgentAcksResponse.action","type":"string","label":"action","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L89"}}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L88"},"initialIsOpen":false},{"id":"def-common.PostNewAgentActionRequest","type":"Interface","label":"PostNewAgentActionRequest","description":[],"children":[{"id":"def-common.PostNewAgentActionRequest.body","type":"Object","label":"body","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":93,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L93"},"signature":["{ action: ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.NewAgentAction","text":"NewAgentAction"},"; }"]},{"id":"def-common.PostNewAgentActionRequest.params","type":"Object","label":"params","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L96"},"signature":["{ agentId: string; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L92"},"initialIsOpen":false},{"id":"def-common.PostNewAgentActionResponse","type":"Interface","label":"PostNewAgentActionResponse","description":[],"children":[{"id":"def-common.PostNewAgentActionResponse.item","type":"Object","label":"item","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L102"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AgentAction","text":"AgentAction"}]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L101"},"initialIsOpen":false},{"id":"def-common.PostAgentUnenrollRequest","type":"Interface","label":"PostAgentUnenrollRequest","description":[],"children":[{"id":"def-common.PostAgentUnenrollRequest.params","type":"Object","label":"params","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":106,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L106"},"signature":["{ agentId: string; }"]},{"id":"def-common.PostAgentUnenrollRequest.body","type":"Object","label":"body","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":109,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L109"},"signature":["{ force?: boolean | undefined; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":105,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L105"},"initialIsOpen":false},{"id":"def-common.PostAgentUnenrollResponse","type":"Interface","label":"PostAgentUnenrollResponse","description":[],"children":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L115"},"initialIsOpen":false},{"id":"def-common.PostBulkAgentUnenrollRequest","type":"Interface","label":"PostBulkAgentUnenrollRequest","description":[],"children":[{"id":"def-common.PostBulkAgentUnenrollRequest.body","type":"Object","label":"body","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":118,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L118"},"signature":["{ agents: string | string[]; force?: boolean | undefined; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":117,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L117"},"initialIsOpen":false},{"id":"def-common.PostBulkAgentUnenrollResponse","type":"Interface","label":"PostBulkAgentUnenrollResponse","description":[],"children":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":125,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L125"},"initialIsOpen":false},{"id":"def-common.PostAgentUpgradeRequest","type":"Interface","label":"PostAgentUpgradeRequest","description":[],"children":[{"id":"def-common.PostAgentUpgradeRequest.params","type":"Object","label":"params","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":128,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L128"},"signature":["{ agentId: string; }"]},{"id":"def-common.PostAgentUpgradeRequest.body","type":"Object","label":"body","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L131"},"signature":["{ source_uri?: string | undefined; version: string; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":127,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L127"},"initialIsOpen":false},{"id":"def-common.PostBulkAgentUpgradeRequest","type":"Interface","label":"PostBulkAgentUpgradeRequest","description":[],"children":[{"id":"def-common.PostBulkAgentUpgradeRequest.body","type":"Object","label":"body","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":138,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L138"},"signature":["{ agents: string | string[]; source_uri?: string | undefined; version: string; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":137,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L137"},"initialIsOpen":false},{"id":"def-common.PostBulkAgentUpgradeResponse","type":"Interface","label":"PostBulkAgentUpgradeResponse","description":[],"children":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":145,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L145"},"initialIsOpen":false},{"id":"def-common.PostAgentUpgradeResponse","type":"Interface","label":"PostAgentUpgradeResponse","description":[],"children":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":148,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L148"},"initialIsOpen":false},{"id":"def-common.PutAgentReassignRequest","type":"Interface","label":"PutAgentReassignRequest","description":[],"children":[{"id":"def-common.PutAgentReassignRequest.params","type":"Object","label":"params","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":151,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L151"},"signature":["{ agentId: string; }"]},{"id":"def-common.PutAgentReassignRequest.body","type":"Object","label":"body","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":154,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L154"},"signature":["{ policy_id: string; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":150,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L150"},"initialIsOpen":false},{"id":"def-common.PutAgentReassignResponse","type":"Interface","label":"PutAgentReassignResponse","description":[],"children":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":158,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L158"},"initialIsOpen":false},{"id":"def-common.PostBulkAgentReassignRequest","type":"Interface","label":"PostBulkAgentReassignRequest","description":[],"children":[{"id":"def-common.PostBulkAgentReassignRequest.body","type":"Object","label":"body","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":161,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L161"},"signature":["{ policy_id: string; agents: string | string[]; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":160,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L160"},"initialIsOpen":false},{"id":"def-common.PostBulkAgentReassignResponse","type":"Interface","label":"PostBulkAgentReassignResponse","description":[],"children":[{"id":"def-common.PostBulkAgentReassignResponse.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":168,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L168"},"signature":["any"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":167,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L167"},"initialIsOpen":false},{"id":"def-common.GetOneAgentEventsRequest","type":"Interface","label":"GetOneAgentEventsRequest","description":[],"children":[{"id":"def-common.GetOneAgentEventsRequest.params","type":"Object","label":"params","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":175,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L175"},"signature":["{ agentId: string; }"]},{"id":"def-common.GetOneAgentEventsRequest.query","type":"Object","label":"query","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":178,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L178"},"signature":["{ page: number; perPage: number; kuery?: string | undefined; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":174,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L174"},"initialIsOpen":false},{"id":"def-common.GetOneAgentEventsResponse","type":"Interface","label":"GetOneAgentEventsResponse","description":[],"children":[{"id":"def-common.GetOneAgentEventsResponse.list","type":"Array","label":"list","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":186,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L186"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AgentEvent","text":"AgentEvent"},"[]"]},{"id":"def-common.GetOneAgentEventsResponse.total","type":"number","label":"total","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":187,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L187"}},{"id":"def-common.GetOneAgentEventsResponse.page","type":"number","label":"page","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":188,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L188"}},{"id":"def-common.GetOneAgentEventsResponse.perPage","type":"number","label":"perPage","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":189,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L189"}}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":185,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L185"},"initialIsOpen":false},{"id":"def-common.DeleteAgentRequest","type":"Interface","label":"DeleteAgentRequest","description":[],"children":[{"id":"def-common.DeleteAgentRequest.params","type":"Object","label":"params","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":193,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L193"},"signature":["{ agentId: string; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":192,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L192"},"initialIsOpen":false},{"id":"def-common.UpdateAgentRequest","type":"Interface","label":"UpdateAgentRequest","description":[],"children":[{"id":"def-common.UpdateAgentRequest.params","type":"Object","label":"params","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":199,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L199"},"signature":["{ agentId: string; }"]},{"id":"def-common.UpdateAgentRequest.body","type":"Object","label":"body","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":202,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L202"},"signature":["{ user_provided_metadata: Record; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":198,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L198"},"initialIsOpen":false},{"id":"def-common.GetAgentStatusRequest","type":"Interface","label":"GetAgentStatusRequest","description":[],"children":[{"id":"def-common.GetAgentStatusRequest.query","type":"Object","label":"query","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":208,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L208"},"signature":["{ kuery?: string | undefined; policyId?: string | undefined; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":207,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L207"},"initialIsOpen":false},{"id":"def-common.GetAgentStatusResponse","type":"Interface","label":"GetAgentStatusResponse","description":[],"children":[{"id":"def-common.GetAgentStatusResponse.results","type":"Object","label":"results","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":215,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L215"},"signature":["{ events: number; total: number; online: number; error: number; offline: number; other: number; updating: number; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent.ts","lineNumber":214,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent.ts#L214"},"initialIsOpen":false},{"id":"def-common.GetAgentPoliciesRequest","type":"Interface","label":"GetAgentPoliciesRequest","description":[],"children":[{"id":"def-common.GetAgentPoliciesRequest.query","type":"CompoundType","label":"query","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L12"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.ListWithKuery","text":"ListWithKuery"}," & { full?: boolean | undefined; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L11"},"initialIsOpen":false},{"id":"def-common.GetAgentPoliciesResponse","type":"Interface","label":"GetAgentPoliciesResponse","description":[],"children":[{"id":"def-common.GetAgentPoliciesResponse.items","type":"Array","label":"items","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L20"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.GetAgentPoliciesResponseItem","text":"GetAgentPoliciesResponseItem"},"[]"]},{"id":"def-common.GetAgentPoliciesResponse.total","type":"number","label":"total","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L21"}},{"id":"def-common.GetAgentPoliciesResponse.page","type":"number","label":"page","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L22"}},{"id":"def-common.GetAgentPoliciesResponse.perPage","type":"number","label":"perPage","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L23"}}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L19"},"initialIsOpen":false},{"id":"def-common.GetOneAgentPolicyRequest","type":"Interface","label":"GetOneAgentPolicyRequest","description":[],"children":[{"id":"def-common.GetOneAgentPolicyRequest.params","type":"Object","label":"params","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L27"},"signature":["{ agentPolicyId: string; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L26"},"initialIsOpen":false},{"id":"def-common.GetOneAgentPolicyResponse","type":"Interface","label":"GetOneAgentPolicyResponse","description":[],"children":[{"id":"def-common.GetOneAgentPolicyResponse.item","type":"Object","label":"item","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L33"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AgentPolicy","text":"AgentPolicy"}]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L32"},"initialIsOpen":false},{"id":"def-common.CreateAgentPolicyRequest","type":"Interface","label":"CreateAgentPolicyRequest","description":[],"children":[{"id":"def-common.CreateAgentPolicyRequest.body","type":"Object","label":"body","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L37"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.NewAgentPolicy","text":"NewAgentPolicy"}]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L36"},"initialIsOpen":false},{"id":"def-common.CreateAgentPolicyResponse","type":"Interface","label":"CreateAgentPolicyResponse","description":[],"children":[{"id":"def-common.CreateAgentPolicyResponse.item","type":"Object","label":"item","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L41"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AgentPolicy","text":"AgentPolicy"}]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L40"},"initialIsOpen":false},{"id":"def-common.UpdateAgentPolicyResponse","type":"Interface","label":"UpdateAgentPolicyResponse","description":[],"children":[{"id":"def-common.UpdateAgentPolicyResponse.item","type":"Object","label":"item","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L49"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AgentPolicy","text":"AgentPolicy"}]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L48"},"initialIsOpen":false},{"id":"def-common.CopyAgentPolicyRequest","type":"Interface","label":"CopyAgentPolicyRequest","description":[],"children":[{"id":"def-common.CopyAgentPolicyRequest.body","type":"Object","label":"body","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L53"},"signature":["Pick<",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AgentPolicy","text":"AgentPolicy"},", \"description\" | \"name\">"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L52"},"initialIsOpen":false},{"id":"def-common.CopyAgentPolicyResponse","type":"Interface","label":"CopyAgentPolicyResponse","description":[],"children":[{"id":"def-common.CopyAgentPolicyResponse.item","type":"Object","label":"item","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L57"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AgentPolicy","text":"AgentPolicy"}]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L56"},"initialIsOpen":false},{"id":"def-common.DeleteAgentPolicyRequest","type":"Interface","label":"DeleteAgentPolicyRequest","description":[],"children":[{"id":"def-common.DeleteAgentPolicyRequest.body","type":"Object","label":"body","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L61"},"signature":["{ agentPolicyId: string; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L60"},"initialIsOpen":false},{"id":"def-common.DeleteAgentPolicyResponse","type":"Interface","label":"DeleteAgentPolicyResponse","description":[],"children":[{"id":"def-common.DeleteAgentPolicyResponse.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L67"}},{"id":"def-common.DeleteAgentPolicyResponse.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L68"}}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L66"},"initialIsOpen":false},{"id":"def-common.GetFullAgentPolicyRequest","type":"Interface","label":"GetFullAgentPolicyRequest","description":[],"children":[{"id":"def-common.GetFullAgentPolicyRequest.params","type":"Object","label":"params","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L72"},"signature":["{ agentPolicyId: string; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L71"},"initialIsOpen":false},{"id":"def-common.GetFullAgentPolicyResponse","type":"Interface","label":"GetFullAgentPolicyResponse","description":[],"children":[{"id":"def-common.GetFullAgentPolicyResponse.item","type":"Object","label":"item","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L78"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.FullAgentPolicy","text":"FullAgentPolicy"}]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L77"},"initialIsOpen":false},{"id":"def-common.CreateFleetSetupResponse","type":"Interface","label":"CreateFleetSetupResponse","description":[],"children":[{"id":"def-common.CreateFleetSetupResponse.isInitialized","type":"boolean","label":"isInitialized","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts#L9"}}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts#L8"},"initialIsOpen":false},{"id":"def-common.GetFleetStatusResponse","type":"Interface","label":"GetFleetStatusResponse","description":[],"children":[{"id":"def-common.GetFleetStatusResponse.isReady","type":"boolean","label":"isReady","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts#L13"}},{"id":"def-common.GetFleetStatusResponse.missing_requirements","type":"Array","label":"missing_requirements","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts#L14"},"signature":["(\"tls_required\" | \"api_keys\" | \"fleet_admin_user\" | \"encrypted_saved_object_encryption_key_required\")[]"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/fleet_setup.ts#L12"},"initialIsOpen":false},{"id":"def-common.GetCategoriesRequest","type":"Interface","label":"GetCategoriesRequest","description":[],"children":[{"id":"def-common.GetCategoriesRequest.query","type":"Object","label":"query","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L18"},"signature":["{ experimental?: boolean | undefined; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L17"},"initialIsOpen":false},{"id":"def-common.GetCategoriesResponse","type":"Interface","label":"GetCategoriesResponse","description":[],"children":[{"id":"def-common.GetCategoriesResponse.response","type":"Array","label":"response","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L24"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.CategorySummaryList","text":"CategorySummaryList"}]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L23"},"initialIsOpen":false},{"id":"def-common.GetPackagesRequest","type":"Interface","label":"GetPackagesRequest","description":[],"children":[{"id":"def-common.GetPackagesRequest.query","type":"Object","label":"query","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L28"},"signature":["{ category?: string | undefined; experimental?: boolean | undefined; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L27"},"initialIsOpen":false},{"id":"def-common.GetPackagesResponse","type":"Interface","label":"GetPackagesResponse","description":[],"children":[{"id":"def-common.GetPackagesResponse.response","type":"Array","label":"response","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L35"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.Installable","text":"Installable"},">[]"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L34"},"initialIsOpen":false},{"id":"def-common.GetLimitedPackagesResponse","type":"Interface","label":"GetLimitedPackagesResponse","description":[],"children":[{"id":"def-common.GetLimitedPackagesResponse.response","type":"Array","label":"response","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L39"},"signature":["string[]"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L38"},"initialIsOpen":false},{"id":"def-common.GetFileRequest","type":"Interface","label":"GetFileRequest","description":[],"children":[{"id":"def-common.GetFileRequest.params","type":"Object","label":"params","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L43"},"signature":["{ pkgkey: string; filePath: string; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L42"},"initialIsOpen":false},{"id":"def-common.GetInfoRequest","type":"Interface","label":"GetInfoRequest","description":[],"children":[{"id":"def-common.GetInfoRequest.params","type":"Object","label":"params","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L50"},"signature":["{ pkgkey: string; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L49"},"initialIsOpen":false},{"id":"def-common.GetInfoResponse","type":"Interface","label":"GetInfoResponse","description":[],"children":[{"id":"def-common.GetInfoResponse.response","type":"CompoundType","label":"response","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L56"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.PackageInfo","text":"PackageInfo"}]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L55"},"initialIsOpen":false},{"id":"def-common.GetStatsRequest","type":"Interface","label":"GetStatsRequest","description":[],"children":[{"id":"def-common.GetStatsRequest.params","type":"Object","label":"params","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L60"},"signature":["{ pkgname: string; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L59"},"initialIsOpen":false},{"id":"def-common.GetStatsResponse","type":"Interface","label":"GetStatsResponse","description":[],"children":[{"id":"def-common.GetStatsResponse.response","type":"Object","label":"response","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L66"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.PackageUsageStats","text":"PackageUsageStats"}]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L65"},"initialIsOpen":false},{"id":"def-common.InstallPackageRequest","type":"Interface","label":"InstallPackageRequest","description":[],"children":[{"id":"def-common.InstallPackageRequest.params","type":"Object","label":"params","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L70"},"signature":["{ pkgkey: string; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L69"},"initialIsOpen":false},{"id":"def-common.InstallPackageResponse","type":"Interface","label":"InstallPackageResponse","description":[],"children":[{"id":"def-common.InstallPackageResponse.response","type":"Array","label":"response","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":76,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L76"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AssetReference","text":"AssetReference"},"[]"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L75"},"initialIsOpen":false},{"id":"def-common.IBulkInstallPackageHTTPError","type":"Interface","label":"IBulkInstallPackageHTTPError","description":[],"children":[{"id":"def-common.IBulkInstallPackageHTTPError.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L80"}},{"id":"def-common.IBulkInstallPackageHTTPError.statusCode","type":"number","label":"statusCode","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L81"}},{"id":"def-common.IBulkInstallPackageHTTPError.error","type":"CompoundType","label":"error","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L82"},"signature":["string | Error"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L79"},"initialIsOpen":false},{"id":"def-common.BulkInstallPackageInfo","type":"Interface","label":"BulkInstallPackageInfo","description":[],"children":[{"id":"def-common.BulkInstallPackageInfo.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L86"}},{"id":"def-common.BulkInstallPackageInfo.newVersion","type":"string","label":"newVersion","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":87,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L87"}},{"id":"def-common.BulkInstallPackageInfo.oldVersion","type":"CompoundType","label":"oldVersion","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L89"},"signature":["string | null"]},{"id":"def-common.BulkInstallPackageInfo.assets","type":"Array","label":"assets","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L90"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AssetReference","text":"AssetReference"},"[]"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":85,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L85"},"initialIsOpen":false},{"id":"def-common.BulkInstallPackagesResponse","type":"Interface","label":"BulkInstallPackagesResponse","description":[],"children":[{"id":"def-common.BulkInstallPackagesResponse.response","type":"Array","label":"response","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L94"},"signature":["(",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.IBulkInstallPackageHTTPError","text":"IBulkInstallPackageHTTPError"}," | ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.BulkInstallPackageInfo","text":"BulkInstallPackageInfo"},")[]"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":93,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L93"},"initialIsOpen":false},{"id":"def-common.BulkInstallPackagesRequest","type":"Interface","label":"BulkInstallPackagesRequest","description":[],"children":[{"id":"def-common.BulkInstallPackagesRequest.body","type":"Object","label":"body","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L98"},"signature":["{ packages: string[]; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L97"},"initialIsOpen":false},{"id":"def-common.MessageResponse","type":"Interface","label":"MessageResponse","description":[],"children":[{"id":"def-common.MessageResponse.response","type":"string","label":"response","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L104"}}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L103"},"initialIsOpen":false},{"id":"def-common.DeletePackageRequest","type":"Interface","label":"DeletePackageRequest","description":[],"children":[{"id":"def-common.DeletePackageRequest.params","type":"Object","label":"params","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L108"},"signature":["{ pkgkey: string; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":107,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L107"},"initialIsOpen":false},{"id":"def-common.DeletePackageResponse","type":"Interface","label":"DeletePackageResponse","description":[],"children":[{"id":"def-common.DeletePackageResponse.response","type":"Array","label":"response","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":114,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L114"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AssetReference","text":"AssetReference"},"[]"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/epm.ts","lineNumber":113,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/epm.ts#L113"},"initialIsOpen":false},{"id":"def-common.GetEnrollmentAPIKeysRequest","type":"Interface","label":"GetEnrollmentAPIKeysRequest","description":[],"children":[{"id":"def-common.GetEnrollmentAPIKeysRequest.query","type":"Object","label":"query","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L11"},"signature":["{ page: number; perPage: number; kuery?: string | undefined; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L10"},"initialIsOpen":false},{"id":"def-common.GetEnrollmentAPIKeysResponse","type":"Interface","label":"GetEnrollmentAPIKeysResponse","description":[],"children":[{"id":"def-common.GetEnrollmentAPIKeysResponse.list","type":"Array","label":"list","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L19"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.EnrollmentAPIKey","text":"EnrollmentAPIKey"},"[]"]},{"id":"def-common.GetEnrollmentAPIKeysResponse.total","type":"number","label":"total","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L20"}},{"id":"def-common.GetEnrollmentAPIKeysResponse.page","type":"number","label":"page","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L21"}},{"id":"def-common.GetEnrollmentAPIKeysResponse.perPage","type":"number","label":"perPage","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L22"}}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L18"},"initialIsOpen":false},{"id":"def-common.GetOneEnrollmentAPIKeyRequest","type":"Interface","label":"GetOneEnrollmentAPIKeyRequest","description":[],"children":[{"id":"def-common.GetOneEnrollmentAPIKeyRequest.params","type":"Object","label":"params","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L26"},"signature":["{ keyId: string; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L25"},"initialIsOpen":false},{"id":"def-common.GetOneEnrollmentAPIKeyResponse","type":"Interface","label":"GetOneEnrollmentAPIKeyResponse","description":[],"children":[{"id":"def-common.GetOneEnrollmentAPIKeyResponse.item","type":"Object","label":"item","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L32"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.EnrollmentAPIKey","text":"EnrollmentAPIKey"}]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L31"},"initialIsOpen":false},{"id":"def-common.DeleteEnrollmentAPIKeyRequest","type":"Interface","label":"DeleteEnrollmentAPIKeyRequest","description":[],"children":[{"id":"def-common.DeleteEnrollmentAPIKeyRequest.params","type":"Object","label":"params","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L36"},"signature":["{ keyId: string; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L35"},"initialIsOpen":false},{"id":"def-common.DeleteEnrollmentAPIKeyResponse","type":"Interface","label":"DeleteEnrollmentAPIKeyResponse","description":[],"children":[{"id":"def-common.DeleteEnrollmentAPIKeyResponse.action","type":"string","label":"action","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L42"}}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L41"},"initialIsOpen":false},{"id":"def-common.PostEnrollmentAPIKeyRequest","type":"Interface","label":"PostEnrollmentAPIKeyRequest","description":[],"children":[{"id":"def-common.PostEnrollmentAPIKeyRequest.body","type":"Object","label":"body","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L46"},"signature":["{ name?: string | undefined; policy_id: string; expiration?: string | undefined; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L45"},"initialIsOpen":false},{"id":"def-common.PostEnrollmentAPIKeyResponse","type":"Interface","label":"PostEnrollmentAPIKeyResponse","description":[],"children":[{"id":"def-common.PostEnrollmentAPIKeyResponse.action","type":"string","label":"action","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L54"}},{"id":"def-common.PostEnrollmentAPIKeyResponse.item","type":"Object","label":"item","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L55"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.EnrollmentAPIKey","text":"EnrollmentAPIKey"}]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/enrollment_api_key.ts#L53"},"initialIsOpen":false},{"id":"def-common.InstallScriptRequest","type":"Interface","label":"InstallScriptRequest","description":[],"children":[{"id":"def-common.InstallScriptRequest.params","type":"Object","label":"params","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/install_script.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/install_script.ts#L9"},"signature":["{ osType: \"macos\"; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/install_script.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/install_script.ts#L8"},"initialIsOpen":false},{"id":"def-common.PostIngestSetupResponse","type":"Interface","label":"PostIngestSetupResponse","description":[],"children":[{"id":"def-common.PostIngestSetupResponse.isInitialized","type":"boolean","label":"isInitialized","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/ingest_setup.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/ingest_setup.ts#L9"}}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/ingest_setup.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/ingest_setup.ts#L8"},"initialIsOpen":false},{"id":"def-common.GetOneOutputResponse","type":"Interface","label":"GetOneOutputResponse","description":[],"children":[{"id":"def-common.GetOneOutputResponse.item","type":"CompoundType","label":"item","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/output.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/output.ts#L11"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.Output","text":"Output"}]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/output.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/output.ts#L10"},"initialIsOpen":false},{"id":"def-common.GetOneOutputRequest","type":"Interface","label":"GetOneOutputRequest","description":[],"children":[{"id":"def-common.GetOneOutputRequest.params","type":"Object","label":"params","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/output.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/output.ts#L15"},"signature":["{ outputId: string; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/output.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/output.ts#L14"},"initialIsOpen":false},{"id":"def-common.PutOutputRequest","type":"Interface","label":"PutOutputRequest","description":[],"children":[{"id":"def-common.PutOutputRequest.params","type":"Object","label":"params","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/output.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/output.ts#L21"},"signature":["{ outputId: string; }"]},{"id":"def-common.PutOutputRequest.body","type":"Object","label":"body","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/output.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/output.ts#L24"},"signature":["{ hosts?: string[] | undefined; ca_sha256?: string | undefined; config?: Record | undefined; config_yaml?: string | undefined; }"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/output.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/output.ts#L20"},"initialIsOpen":false},{"id":"def-common.PutOutputResponse","type":"Interface","label":"PutOutputResponse","description":[],"children":[{"id":"def-common.PutOutputResponse.item","type":"CompoundType","label":"item","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/output.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/output.ts#L33"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.Output","text":"Output"}]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/output.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/output.ts#L32"},"initialIsOpen":false},{"id":"def-common.GetOutputsResponse","type":"Interface","label":"GetOutputsResponse","description":[],"children":[{"id":"def-common.GetOutputsResponse.items","type":"Array","label":"items","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/output.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/output.ts#L37"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.Output","text":"Output"},"[]"]},{"id":"def-common.GetOutputsResponse.total","type":"number","label":"total","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/output.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/output.ts#L38"}},{"id":"def-common.GetOutputsResponse.page","type":"number","label":"page","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/output.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/output.ts#L39"}},{"id":"def-common.GetOutputsResponse.perPage","type":"number","label":"perPage","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/output.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/output.ts#L40"}}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/output.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/output.ts#L36"},"initialIsOpen":false},{"id":"def-common.GetSettingsResponse","type":"Interface","label":"GetSettingsResponse","description":[],"children":[{"id":"def-common.GetSettingsResponse.item","type":"Object","label":"item","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/settings.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/settings.ts#L11"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.Settings","text":"Settings"}]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/settings.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/settings.ts#L10"},"initialIsOpen":false},{"id":"def-common.PutSettingsRequest","type":"Interface","label":"PutSettingsRequest","description":[],"children":[{"id":"def-common.PutSettingsRequest.body","type":"Object","label":"body","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/settings.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/settings.ts#L15"},"signature":["Partial>"]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/settings.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/settings.ts#L14"},"initialIsOpen":false},{"id":"def-common.PutSettingsResponse","type":"Interface","label":"PutSettingsResponse","description":[],"children":[{"id":"def-common.PutSettingsResponse.item","type":"Object","label":"item","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/settings.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/settings.ts#L19"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.Settings","text":"Settings"}]}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/settings.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/settings.ts#L18"},"initialIsOpen":false},{"id":"def-common.CheckPermissionsResponse","type":"Interface","label":"CheckPermissionsResponse","description":[],"children":[{"id":"def-common.CheckPermissionsResponse.error","type":"CompoundType","label":"error","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/app.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/app.ts#L9"},"signature":["\"MISSING_SECURITY\" | \"MISSING_SUPERUSER_ROLE\" | undefined"]},{"id":"def-common.CheckPermissionsResponse.success","type":"boolean","label":"success","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/app.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/app.ts#L10"}}],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/app.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/app.ts#L8"},"initialIsOpen":false}],"enums":[{"id":"def-common.InstallStatus","type":"Enum","label":"InstallStatus","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L24"},"initialIsOpen":false},{"id":"def-common.KibanaAssetType","type":"Enum","label":"KibanaAssetType","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L44"},"initialIsOpen":false},{"id":"def-common.KibanaSavedObjectType","type":"Enum","label":"KibanaSavedObjectType","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L56"},"initialIsOpen":false},{"id":"def-common.ElasticsearchAssetType","type":"Enum","label":"ElasticsearchAssetType","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L65"},"initialIsOpen":false}],"misc":[{"id":"def-common.SO_SEARCH_LIMIT","type":"number","label":"SO_SEARCH_LIMIT","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/index.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/index.ts#L23"},"signature":["10000"],"initialIsOpen":false},{"id":"def-common.FLEET_SERVER_INDICES_VERSION","type":"number","label":"FLEET_SERVER_INDICES_VERSION","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/index.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/index.ts#L25"},"signature":["1"],"initialIsOpen":false},{"id":"def-common.FLEET_SERVER_INDICES","type":"Array","label":"FLEET_SERVER_INDICES","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/index.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/index.ts#L27"},"signature":["string[]"],"initialIsOpen":false},{"id":"def-common.PLUGIN_ID","type":"string","label":"PLUGIN_ID","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/plugin.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/plugin.ts#L8"},"signature":["\"fleet\""],"initialIsOpen":false},{"id":"def-common.API_ROOT","type":"string","label":"API_ROOT","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L10"},"signature":["\"/api/fleet\""],"initialIsOpen":false},{"id":"def-common.EPM_API_ROOT","type":"string","label":"EPM_API_ROOT","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L11"},"initialIsOpen":false},{"id":"def-common.DATA_STREAM_API_ROOT","type":"string","label":"DATA_STREAM_API_ROOT","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L12"},"initialIsOpen":false},{"id":"def-common.PACKAGE_POLICY_API_ROOT","type":"string","label":"PACKAGE_POLICY_API_ROOT","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L13"},"initialIsOpen":false},{"id":"def-common.AGENT_POLICY_API_ROOT","type":"string","label":"AGENT_POLICY_API_ROOT","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L14"},"initialIsOpen":false},{"id":"def-common.FLEET_API_ROOT_7_9","type":"string","label":"FLEET_API_ROOT_7_9","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L15"},"signature":["\"/api/ingest_manager/fleet\""],"initialIsOpen":false},{"id":"def-common.LIMITED_CONCURRENCY_ROUTE_TAG","type":"string","label":"LIMITED_CONCURRENCY_ROUTE_TAG","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L17"},"signature":["\"ingest:limited-concurrency\""],"initialIsOpen":false},{"id":"def-common.SETUP_API_ROUTE","type":"string","label":"SETUP_API_ROUTE","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":119,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L119"},"initialIsOpen":false},{"id":"def-common.INSTALL_SCRIPT_API_ROUTES","type":"string","label":"INSTALL_SCRIPT_API_ROUTES","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":121,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L121"},"initialIsOpen":false},{"id":"def-common.AGENT_SAVED_OBJECT_TYPE","type":"string","label":"AGENT_SAVED_OBJECT_TYPE","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L8"},"signature":["\"fleet-agents\""],"initialIsOpen":false},{"id":"def-common.AGENT_EVENT_SAVED_OBJECT_TYPE","type":"string","label":"AGENT_EVENT_SAVED_OBJECT_TYPE","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L11"},"signature":["\"fleet-agent-events\""],"initialIsOpen":false},{"id":"def-common.AGENT_ACTION_SAVED_OBJECT_TYPE","type":"string","label":"AGENT_ACTION_SAVED_OBJECT_TYPE","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L12"},"signature":["\"fleet-agent-actions\""],"initialIsOpen":false},{"id":"def-common.AGENT_TYPE_PERMANENT","type":"string","label":"AGENT_TYPE_PERMANENT","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L14"},"signature":["\"PERMANENT\""],"initialIsOpen":false},{"id":"def-common.AGENT_TYPE_EPHEMERAL","type":"string","label":"AGENT_TYPE_EPHEMERAL","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L15"},"signature":["\"EPHEMERAL\""],"initialIsOpen":false},{"id":"def-common.AGENT_TYPE_TEMPORARY","type":"string","label":"AGENT_TYPE_TEMPORARY","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L16"},"signature":["\"TEMPORARY\""],"initialIsOpen":false},{"id":"def-common.AGENT_POLLING_REQUEST_TIMEOUT_MS","type":"number","label":"AGENT_POLLING_REQUEST_TIMEOUT_MS","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L18"},"signature":["300000"],"initialIsOpen":false},{"id":"def-common.AGENT_POLLING_REQUEST_TIMEOUT_MARGIN_MS","type":"number","label":"AGENT_POLLING_REQUEST_TIMEOUT_MARGIN_MS","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L19"},"signature":["20000"],"initialIsOpen":false},{"id":"def-common.AGENT_POLLING_THRESHOLD_MS","type":"number","label":"AGENT_POLLING_THRESHOLD_MS","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L21"},"signature":["30000"],"initialIsOpen":false},{"id":"def-common.AGENT_POLLING_INTERVAL","type":"number","label":"AGENT_POLLING_INTERVAL","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L22"},"signature":["1000"],"initialIsOpen":false},{"id":"def-common.AGENT_UPDATE_LAST_CHECKIN_INTERVAL_MS","type":"number","label":"AGENT_UPDATE_LAST_CHECKIN_INTERVAL_MS","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L23"},"signature":["30000"],"initialIsOpen":false},{"id":"def-common.AGENT_UPDATE_ACTIONS_INTERVAL_MS","type":"number","label":"AGENT_UPDATE_ACTIONS_INTERVAL_MS","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L24"},"signature":["5000"],"initialIsOpen":false},{"id":"def-common.AGENT_POLICY_ROLLOUT_RATE_LIMIT_INTERVAL_MS","type":"number","label":"AGENT_POLICY_ROLLOUT_RATE_LIMIT_INTERVAL_MS","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L26"},"signature":["1000"],"initialIsOpen":false},{"id":"def-common.AGENT_POLICY_ROLLOUT_RATE_LIMIT_REQUEST_PER_INTERVAL","type":"number","label":"AGENT_POLICY_ROLLOUT_RATE_LIMIT_REQUEST_PER_INTERVAL","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L27"},"signature":["5"],"initialIsOpen":false},{"id":"def-common.AGENTS_INDEX","type":"string","label":"AGENTS_INDEX","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L29"},"signature":["\".fleet-agents\""],"initialIsOpen":false},{"id":"def-common.AGENT_ACTIONS_INDEX","type":"string","label":"AGENT_ACTIONS_INDEX","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent.ts#L30"},"signature":["\".fleet-actions\""],"initialIsOpen":false},{"id":"def-common.AGENT_POLICY_SAVED_OBJECT_TYPE","type":"string","label":"AGENT_POLICY_SAVED_OBJECT_TYPE","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent_policy.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L10"},"signature":["\"ingest-agent-policies\""],"initialIsOpen":false},{"id":"def-common.AGENT_POLICY_INDEX","type":"string","label":"AGENT_POLICY_INDEX","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent_policy.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L11"},"signature":["\".fleet-policies\""],"initialIsOpen":false},{"id":"def-common.DEFAULT_AGENT_POLICIES_PACKAGES","type":"Array","label":"DEFAULT_AGENT_POLICIES_PACKAGES","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent_policy.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L46"},"signature":["\"system\"[]"],"initialIsOpen":false},{"id":"def-common.PACKAGE_POLICY_SAVED_OBJECT_TYPE","type":"string","label":"PACKAGE_POLICY_SAVED_OBJECT_TYPE","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/package_policy.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/package_policy.ts#L8"},"signature":["\"ingest-package-policies\""],"initialIsOpen":false},{"id":"def-common.PACKAGES_SAVED_OBJECT_TYPE","type":"string","label":"PACKAGES_SAVED_OBJECT_TYPE","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/epm.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/epm.ts#L8"},"signature":["\"epm-packages\""],"initialIsOpen":false},{"id":"def-common.ASSETS_SAVED_OBJECT_TYPE","type":"string","label":"ASSETS_SAVED_OBJECT_TYPE","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/epm.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/epm.ts#L9"},"signature":["\"epm-packages-assets\""],"initialIsOpen":false},{"id":"def-common.INDEX_PATTERN_SAVED_OBJECT_TYPE","type":"string","label":"INDEX_PATTERN_SAVED_OBJECT_TYPE","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/epm.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/epm.ts#L10"},"signature":["\"index-pattern\""],"initialIsOpen":false},{"id":"def-common.MAX_TIME_COMPLETE_INSTALL","type":"number","label":"MAX_TIME_COMPLETE_INSTALL","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/epm.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/epm.ts#L11"},"signature":["60000"],"initialIsOpen":false},{"id":"def-common.FLEET_SERVER_PACKAGE","type":"string","label":"FLEET_SERVER_PACKAGE","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/epm.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/epm.ts#L13"},"signature":["\"fleet_server\""],"initialIsOpen":false},{"id":"def-common.OUTPUT_SAVED_OBJECT_TYPE","type":"string","label":"OUTPUT_SAVED_OBJECT_TYPE","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/output.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/output.ts#L10"},"signature":["\"ingest-outputs\""],"initialIsOpen":false},{"id":"def-common.ENROLLMENT_API_KEYS_SAVED_OBJECT_TYPE","type":"string","label":"ENROLLMENT_API_KEYS_SAVED_OBJECT_TYPE","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/enrollment_api_key.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/enrollment_api_key.ts#L8"},"signature":["\"fleet-enrollment-api-keys\""],"initialIsOpen":false},{"id":"def-common.ENROLLMENT_API_KEYS_INDEX","type":"string","label":"ENROLLMENT_API_KEYS_INDEX","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/enrollment_api_key.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/enrollment_api_key.ts#L10"},"signature":["\".fleet-enrollment-api-keys\""],"initialIsOpen":false},{"id":"def-common.GLOBAL_SETTINGS_SAVED_OBJECT_TYPE","type":"string","label":"GLOBAL_SETTINGS_SAVED_OBJECT_TYPE","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/settings.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/settings.ts#L8"},"signature":["\"ingest_manager_settings\""],"initialIsOpen":false},{"id":"def-common.ValueOf","type":"Type","label":"ValueOf","description":["\nCreates a Union Type for all the values of an object"],"source":{"path":"x-pack/plugins/fleet/common/types/index.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/index.ts#L44"},"signature":["T[keyof T]"],"initialIsOpen":false},{"id":"def-common.AgentType","type":"Type","label":"AgentType","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L11"},"signature":["\"PERMANENT\" | \"EPHEMERAL\" | \"TEMPORARY\""],"initialIsOpen":false},{"id":"def-common.AgentStatus","type":"Type","label":"AgentStatus","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L16"},"signature":["\"warning\" | \"offline\" | \"online\" | \"error\" | \"inactive\" | \"enrolling\" | \"unenrolling\" | \"updating\" | \"degraded\""],"initialIsOpen":false},{"id":"def-common.SimplifiedAgentStatus","type":"Type","label":"SimplifiedAgentStatus","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L27"},"signature":["\"offline\" | \"inactive\" | \"updating\" | \"healthy\" | \"unhealthy\""],"initialIsOpen":false},{"id":"def-common.AgentActionType","type":"Type","label":"AgentActionType","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L29"},"signature":["\"POLICY_CHANGE\" | \"UNENROLL\" | \"UPGRADE\" | \"SETTINGS\" | \"INTERNAL_POLICY_REASSIGN\""],"initialIsOpen":false},{"id":"def-common.AgentPolicyActionV7_9","type":"Type","label":"AgentPolicyActionV7_9","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L67"},"signature":["Pick & { type: 'CONFIG_CHANGE'; data: { config: FullAgentPolicy;}; }"],"initialIsOpen":false},{"id":"def-common.AgentActionSOAttributes","type":"Type","label":"AgentActionSOAttributes","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L83"},"signature":["CommonAgentActionSOAttributes & { agent_id: string; }"],"initialIsOpen":false},{"id":"def-common.AgentPolicyActionSOAttributes","type":"Type","label":"AgentPolicyActionSOAttributes","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L86"},"signature":["CommonAgentActionSOAttributes & { policy_id: string; policy_revision: number; }"],"initialIsOpen":false},{"id":"def-common.BaseAgentActionSOAttributes","type":"Type","label":"BaseAgentActionSOAttributes","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L90"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AgentActionSOAttributes","text":"AgentActionSOAttributes"}," | ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.AgentPolicyActionSOAttributes","text":"AgentPolicyActionSOAttributes"}],"initialIsOpen":false},{"id":"def-common.AgentEventSOAttributes","type":"Type","label":"AgentEventSOAttributes","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent.ts","lineNumber":122,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent.ts#L122"},"signature":["NewAgentEvent"],"initialIsOpen":false},{"id":"def-common.AgentPolicyStatus","type":"Type","label":"AgentPolicyStatus","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L13"},"signature":["{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }"],"initialIsOpen":false},{"id":"def-common.AgentPolicySOAttributes","type":"Type","label":"AgentPolicySOAttributes","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/agent_policy.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/agent_policy.ts#L35"},"signature":["{ status: ValueOf<{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }>; description?: string | undefined; name: string; updated_at: string; namespace: string; is_default?: boolean | undefined; updated_by: string; revision: number; package_policies: string[] | PackagePolicy[]; is_managed: boolean; is_default_fleet_server?: boolean | undefined; monitoring_enabled?: (\"metrics\" | \"logs\")[] | undefined; }"],"initialIsOpen":false},{"id":"def-common.PackagePolicyConfigRecord","type":"Type","label":"PackagePolicyConfigRecord","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L19"},"signature":["{ [x: string]: PackagePolicyConfigRecordEntry; }"],"initialIsOpen":false},{"id":"def-common.PackagePolicySOAttributes","type":"Type","label":"PackagePolicySOAttributes","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_policy.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_policy.ts#L75"},"signature":["{ enabled: boolean; description?: string | undefined; name: string; package?: PackagePolicyPackage | undefined; updated_at: string; namespace: string; inputs: PackagePolicyInput[]; policy_id: string; output_id: string; updated_by: string; revision: number; created_at: string; created_by: string; }"],"initialIsOpen":false},{"id":"def-common.OutputType","type":"Type","label":"OutputType","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/output.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/output.ts#L11"},"signature":["{ readonly Elasticsearch: \"elasticsearch\"; }"],"initialIsOpen":false},{"id":"def-common.OutputSOAttributes","type":"Type","label":"OutputSOAttributes","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/output.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/output.ts#L26"},"signature":["NewOutput"],"initialIsOpen":false},{"id":"def-common.Output","type":"Type","label":"Output","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/output.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/output.ts#L28"},"signature":["NewOutput & { id: string; }"],"initialIsOpen":false},{"id":"def-common.InstallationStatus","type":"Type","label":"InstallationStatus","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L22"},"signature":["{ readonly Installed: \"installed\"; readonly NotInstalled: \"not_installed\"; }"],"initialIsOpen":false},{"id":"def-common.InstallType","type":"Type","label":"InstallType","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L31"},"signature":["\"update\" | \"reinstall\" | \"reupdate\" | \"rollback\" | \"install\""],"initialIsOpen":false},{"id":"def-common.InstallSource","type":"Type","label":"InstallSource","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L32"},"signature":["\"registry\" | \"upload\""],"initialIsOpen":false},{"id":"def-common.EpmPackageInstallStatus","type":"Type","label":"EpmPackageInstallStatus","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L34"},"signature":["\"installed\" | \"installing\""],"initialIsOpen":false},{"id":"def-common.DetailViewPanelName","type":"Type","label":"DetailViewPanelName","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L36"},"signature":["\"custom\" | \"overview\" | \"policies\" | \"settings\""],"initialIsOpen":false},{"id":"def-common.ServiceName","type":"Type","label":"ServiceName","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L37"},"signature":["\"kibana\" | \"elasticsearch\""],"initialIsOpen":false},{"id":"def-common.AgentAssetType","type":"Type","label":"AgentAssetType","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L38"},"signature":["{ readonly Input: \"input\"; }"],"initialIsOpen":false},{"id":"def-common.AssetType","type":"Type","label":"AssetType","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L39"},"signature":["\"input\" | ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.KibanaAssetType","text":"KibanaAssetType"},".dashboard | ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.KibanaAssetType","text":"KibanaAssetType"},".visualization | ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.KibanaAssetType","text":"KibanaAssetType"},".search | ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.KibanaAssetType","text":"KibanaAssetType"},".indexPattern | ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.KibanaAssetType","text":"KibanaAssetType"}],"initialIsOpen":false},{"id":"def-common.DataType","type":"Type","label":"DataType","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L74"},"signature":["{ readonly Logs: \"logs\"; readonly Metrics: \"metrics\"; }"],"initialIsOpen":false},{"id":"def-common.InstallablePackage","type":"Type","label":"InstallablePackage","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":76,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L76"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.RegistryPackage","text":"RegistryPackage"}," | ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.ArchivePackage","text":"ArchivePackage"}],"initialIsOpen":false},{"id":"def-common.ArchivePackage","type":"Type","label":"ArchivePackage","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L78"},"signature":["PackageSpecManifest & Pick"],"initialIsOpen":false},{"id":"def-common.RegistryPackage","type":"Type","label":"RegistryPackage","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L82"},"signature":["PackageSpecManifest & Partial> & RegistryAdditionalProperties & RegistryOverridePropertyValue"],"initialIsOpen":false},{"id":"def-common.RegistryRelease","type":"Type","label":"RegistryRelease","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":109,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L109"},"signature":["\"experimental\" | \"beta\" | \"ga\""],"initialIsOpen":false},{"id":"def-common.RequirementVersion","type":"Type","label":"RequirementVersion","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":142,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L142"},"signature":["string"],"initialIsOpen":false},{"id":"def-common.RequirementVersionRange","type":"Type","label":"RequirementVersionRange","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":143,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L143"},"signature":["string"],"initialIsOpen":false},{"id":"def-common.RegistrySearchResults","type":"Type","label":"RegistrySearchResults","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":151,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L151"},"signature":["Pick[]"],"initialIsOpen":false},{"id":"def-common.RegistrySearchResult","type":"Type","label":"RegistrySearchResult","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":153,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L153"},"signature":["{ type?: \"integration\" | undefined; description: string; title: string; name: string; version: string; path: string; download: string; data_streams?: RegistryDataStream[] | undefined; release: \"experimental\" | \"beta\" | \"ga\"; icons?: (",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.PackageSpecIcon","text":"PackageSpecIcon"},"[] & RegistryImage[]) | undefined; policy_templates?: RegistryPolicyTemplate[] | undefined; internal?: boolean | undefined; }"],"initialIsOpen":false},{"id":"def-common.ScreenshotItem","type":"Type","label":"ScreenshotItem","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":169,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L169"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.RegistryImage","text":"RegistryImage"}," | ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.PackageSpecScreenshot","text":"PackageSpecScreenshot"}],"initialIsOpen":false},{"id":"def-common.CategorySummaryList","type":"Type","label":"CategorySummaryList","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":173,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L173"},"signature":["CategorySummaryItem[]"],"initialIsOpen":false},{"id":"def-common.CategoryId","type":"Type","label":"CategoryId","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":174,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L174"},"signature":["string"],"initialIsOpen":false},{"id":"def-common.RequirementsByServiceName","type":"Type","label":"RequirementsByServiceName","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":181,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L181"},"signature":["undefined | Record<\"kibana\", { version: string; }>"],"initialIsOpen":false},{"id":"def-common.AssetTypeToParts","type":"Type","label":"AssetTypeToParts","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":189,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L189"},"signature":["Record & Record"],"initialIsOpen":false},{"id":"def-common.AssetsGroupedByServiceByType","type":"Type","label":"AssetsGroupedByServiceByType","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":190,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L190"},"signature":["Record<\"kibana\", Record> & Record<\"elasticsearch\", Record>"],"initialIsOpen":false},{"id":"def-common.KibanaAssetParts","type":"Type","label":"KibanaAssetParts","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":196,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L196"},"signature":["AssetParts & { service: Extract; type: KibanaAssetType; }"],"initialIsOpen":false},{"id":"def-common.ElasticsearchAssetParts","type":"Type","label":"ElasticsearchAssetParts","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":201,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L201"},"signature":["AssetParts & { service: Extract; type: ElasticsearchAssetType; }"],"initialIsOpen":false},{"id":"def-common.KibanaAssetTypeToParts","type":"Type","label":"KibanaAssetTypeToParts","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":206,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L206"},"signature":["{ dashboard: KibanaAssetParts[]; visualization: KibanaAssetParts[]; search: KibanaAssetParts[]; index_pattern: KibanaAssetParts[]; map: KibanaAssetParts[]; lens: KibanaAssetParts[]; }"],"initialIsOpen":false},{"id":"def-common.ElasticsearchAssetTypeToParts","type":"Type","label":"ElasticsearchAssetTypeToParts","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":207,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L207"},"signature":["{ component_template: ElasticsearchAssetParts[]; ingest_pipeline: ElasticsearchAssetParts[]; index_template: ElasticsearchAssetParts[]; ilm_policy: ElasticsearchAssetParts[]; transform: ElasticsearchAssetParts[]; data_stream_ilm_policy: ElasticsearchAssetParts[]; }"],"initialIsOpen":false},{"id":"def-common.RegistryVarType","type":"Type","label":"RegistryVarType","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":232,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L232"},"signature":["\"text\" | \"password\" | \"integer\" | \"bool\" | \"yaml\""],"initialIsOpen":false},{"id":"def-common.PackageList","type":"Type","label":"PackageList","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":265,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L265"},"signature":["Installable>[]"],"initialIsOpen":false},{"id":"def-common.PackageListItem","type":"Type","label":"PackageListItem","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":267,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L267"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.Installed","text":"Installed"},"> | ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.NotInstalled","text":"NotInstalled"},">"],"initialIsOpen":false},{"id":"def-common.PackagesGroupedByStatus","type":"Type","label":"PackagesGroupedByStatus","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":268,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L268"},"signature":["{ installed: PackageList; not_installed: PackageList; }"],"initialIsOpen":false},{"id":"def-common.PackageInfo","type":"Type","label":"PackageInfo","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":269,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L269"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.Installed","text":"Installed"},"> | ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.NotInstalled","text":"NotInstalled"}," | ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.NotInstalled","text":"NotInstalled"},""],"initialIsOpen":false},{"id":"def-common.Installed","type":"Type","label":"Installed","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":292,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L292"},"signature":["T & { status: InstallationStatus['Installed']; savedObject: SavedObject; }"],"initialIsOpen":false},{"id":"def-common.NotInstalled","type":"Type","label":"NotInstalled","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":297,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L297"},"signature":["T & { status: InstallationStatus['NotInstalled']; }"],"initialIsOpen":false},{"id":"def-common.AssetReference","type":"Type","label":"AssetReference","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":301,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L301"},"signature":[{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.EsAssetReference","text":"EsAssetReference"}," | ",{"pluginId":"fleet","scope":"common","docId":"kibFleetPluginApi","section":"def-common.KibanaAssetReference","text":"KibanaAssetReference"}],"initialIsOpen":false},{"id":"def-common.KibanaAssetReference","type":"Type","label":"KibanaAssetReference","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":303,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L303"},"signature":["Pick & { type: KibanaSavedObjectType; }"],"initialIsOpen":false},{"id":"def-common.EsAssetReference","type":"Type","label":"EsAssetReference","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":306,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L306"},"signature":["Pick & { type: ElasticsearchAssetType; }"],"initialIsOpen":false},{"id":"def-common.PackageAssetReference","type":"Type","label":"PackageAssetReference","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":310,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L310"},"signature":["Pick & { type: typeof ASSETS_SAVED_OBJECT_TYPE; }"],"initialIsOpen":false},{"id":"def-common.RequiredPackage","type":"Type","label":"RequiredPackage","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":314,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L314"},"signature":["{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; }"],"initialIsOpen":false},{"id":"def-common.DefaultPackages","type":"Type","label":"DefaultPackages","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/epm.ts","lineNumber":316,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/epm.ts#L316"},"signature":["{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; }"],"initialIsOpen":false},{"id":"def-common.PackageSpecCategory","type":"Type","label":"PackageSpecCategory","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_spec.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L28"},"signature":["\"custom\" | \"security\" | \"monitoring\" | \"aws\" | \"azure\" | \"cloud\" | \"config_management\" | \"containers\" | \"crm\" | \"datastore\" | \"elastic_stack\" | \"google_cloud\" | \"kubernetes\" | \"languages\" | \"message_queue\" | \"network\" | \"notification\" | \"os_system\" | \"productivity\" | \"support\" | \"ticketing\" | \"version_control\" | \"web\""],"initialIsOpen":false},{"id":"def-common.PackageSpecConditions","type":"Type","label":"PackageSpecConditions","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/package_spec.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/package_spec.ts#L53"},"signature":["{ kibana: { version: string; }; }"],"initialIsOpen":false},{"id":"def-common.EnrollmentAPIKeySOAttributes","type":"Type","label":"EnrollmentAPIKeySOAttributes","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/models/enrollment_api_key.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/models/enrollment_api_key.ts#L18"},"signature":["{ name?: string | undefined; active: boolean; policy_id?: string | undefined; created_at: string; api_key: string; api_key_id: string; }"],"initialIsOpen":false},{"id":"def-common.UpdatePackagePolicyRequest","type":"Type","label":"UpdatePackagePolicyRequest","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L43"},"signature":["GetOnePackagePolicyRequest & { body: UpdatePackagePolicy; }"],"initialIsOpen":false},{"id":"def-common.UpdatePackagePolicyResponse","type":"Type","label":"UpdatePackagePolicyResponse","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L47"},"signature":["CreatePackagePolicyResponse"],"initialIsOpen":false},{"id":"def-common.DeletePackagePoliciesResponse","type":"Type","label":"DeletePackagePoliciesResponse","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/package_policy.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/package_policy.ts#L55"},"signature":["{ id: string; name?: string | undefined; success: boolean; }[]"],"initialIsOpen":false},{"id":"def-common.GetAgentPoliciesResponseItem","type":"Type","label":"GetAgentPoliciesResponseItem","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L17"},"signature":["AgentPolicy & { agents?: number | undefined; }"],"initialIsOpen":false},{"id":"def-common.UpdateAgentPolicyRequest","type":"Type","label":"UpdateAgentPolicyRequest","description":[],"source":{"path":"x-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/types/rest_spec/agent_policy.ts#L44"},"signature":["GetOneAgentPolicyRequest & { body: NewAgentPolicy; }"],"initialIsOpen":false}],"objects":[{"id":"def-common.EPM_API_ROUTES","type":"Object","children":[{"id":"def-common.EPM_API_ROUTES.BULK_INSTALL_PATTERN","type":"string","label":"BULK_INSTALL_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L25"}},{"id":"def-common.EPM_API_ROUTES.LIST_PATTERN","type":"string","label":"LIST_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L26"}},{"id":"def-common.EPM_API_ROUTES.LIMITED_LIST_PATTERN","type":"string","label":"LIMITED_LIST_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L27"}},{"id":"def-common.EPM_API_ROUTES.INFO_PATTERN","type":"string","label":"INFO_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L28"}},{"id":"def-common.EPM_API_ROUTES.INSTALL_FROM_REGISTRY_PATTERN","type":"string","label":"INSTALL_FROM_REGISTRY_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L29"}},{"id":"def-common.EPM_API_ROUTES.INSTALL_BY_UPLOAD_PATTERN","type":"string","label":"INSTALL_BY_UPLOAD_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L30"}},{"id":"def-common.EPM_API_ROUTES.DELETE_PATTERN","type":"string","label":"DELETE_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L31"}},{"id":"def-common.EPM_API_ROUTES.FILEPATH_PATTERN","type":"string","label":"FILEPATH_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L32"}},{"id":"def-common.EPM_API_ROUTES.CATEGORIES_PATTERN","type":"string","label":"CATEGORIES_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L33"}},{"id":"def-common.EPM_API_ROUTES.STATS_PATTERN","type":"string","label":"STATS_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L34"}}],"description":[],"label":"EPM_API_ROUTES","source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L24"},"initialIsOpen":false},{"id":"def-common.DATA_STREAM_API_ROUTES","type":"Object","children":[{"id":"def-common.DATA_STREAM_API_ROUTES.LIST_PATTERN","type":"string","label":"LIST_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L39"}}],"description":[],"label":"DATA_STREAM_API_ROUTES","source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L38"},"initialIsOpen":false},{"id":"def-common.PACKAGE_POLICY_API_ROUTES","type":"Object","children":[{"id":"def-common.PACKAGE_POLICY_API_ROUTES.LIST_PATTERN","type":"string","label":"LIST_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L44"}},{"id":"def-common.PACKAGE_POLICY_API_ROUTES.INFO_PATTERN","type":"string","label":"INFO_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L45"}},{"id":"def-common.PACKAGE_POLICY_API_ROUTES.CREATE_PATTERN","type":"string","label":"CREATE_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L46"}},{"id":"def-common.PACKAGE_POLICY_API_ROUTES.UPDATE_PATTERN","type":"string","label":"UPDATE_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L47"}},{"id":"def-common.PACKAGE_POLICY_API_ROUTES.DELETE_PATTERN","type":"string","label":"DELETE_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L48"}}],"description":[],"label":"PACKAGE_POLICY_API_ROUTES","source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L43"},"initialIsOpen":false},{"id":"def-common.AGENT_POLICY_API_ROUTES","type":"Object","children":[{"id":"def-common.AGENT_POLICY_API_ROUTES.LIST_PATTERN","type":"string","label":"LIST_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L53"}},{"id":"def-common.AGENT_POLICY_API_ROUTES.INFO_PATTERN","type":"string","label":"INFO_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L54"}},{"id":"def-common.AGENT_POLICY_API_ROUTES.CREATE_PATTERN","type":"string","label":"CREATE_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L55"}},{"id":"def-common.AGENT_POLICY_API_ROUTES.UPDATE_PATTERN","type":"string","label":"UPDATE_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L56"}},{"id":"def-common.AGENT_POLICY_API_ROUTES.COPY_PATTERN","type":"string","label":"COPY_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L57"}},{"id":"def-common.AGENT_POLICY_API_ROUTES.DELETE_PATTERN","type":"string","label":"DELETE_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L58"}},{"id":"def-common.AGENT_POLICY_API_ROUTES.FULL_INFO_PATTERN","type":"string","label":"FULL_INFO_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L59"}},{"id":"def-common.AGENT_POLICY_API_ROUTES.FULL_INFO_DOWNLOAD_PATTERN","type":"string","label":"FULL_INFO_DOWNLOAD_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L60"}}],"description":[],"label":"AGENT_POLICY_API_ROUTES","source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L52"},"initialIsOpen":false},{"id":"def-common.OUTPUT_API_ROUTES","type":"Object","children":[{"id":"def-common.OUTPUT_API_ROUTES.LIST_PATTERN","type":"string","label":"LIST_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L65"}},{"id":"def-common.OUTPUT_API_ROUTES.INFO_PATTERN","type":"string","label":"INFO_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L66"}},{"id":"def-common.OUTPUT_API_ROUTES.UPDATE_PATTERN","type":"string","label":"UPDATE_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":67,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L67"}}],"description":[],"label":"OUTPUT_API_ROUTES","source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L64"},"initialIsOpen":false},{"id":"def-common.SETTINGS_API_ROUTES","type":"Object","children":[{"id":"def-common.SETTINGS_API_ROUTES.INFO_PATTERN","type":"string","label":"INFO_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L72"}},{"id":"def-common.SETTINGS_API_ROUTES.UPDATE_PATTERN","type":"string","label":"UPDATE_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L73"}}],"description":[],"label":"SETTINGS_API_ROUTES","source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L71"},"initialIsOpen":false},{"id":"def-common.APP_API_ROUTES","type":"Object","children":[{"id":"def-common.APP_API_ROUTES.CHECK_PERMISSIONS_PATTERN","type":"string","label":"CHECK_PERMISSIONS_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L78"}}],"description":[],"label":"APP_API_ROUTES","source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L77"},"initialIsOpen":false},{"id":"def-common.AGENT_API_ROUTES","type":"Object","children":[{"id":"def-common.AGENT_API_ROUTES.LIST_PATTERN","type":"string","label":"LIST_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L83"}},{"id":"def-common.AGENT_API_ROUTES.INFO_PATTERN","type":"string","label":"INFO_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":84,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L84"}},{"id":"def-common.AGENT_API_ROUTES.UPDATE_PATTERN","type":"string","label":"UPDATE_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":85,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L85"}},{"id":"def-common.AGENT_API_ROUTES.DELETE_PATTERN","type":"string","label":"DELETE_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L86"}},{"id":"def-common.AGENT_API_ROUTES.EVENTS_PATTERN","type":"string","label":"EVENTS_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":87,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L87"}},{"id":"def-common.AGENT_API_ROUTES.CHECKIN_PATTERN","type":"string","label":"CHECKIN_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L88"}},{"id":"def-common.AGENT_API_ROUTES.ACKS_PATTERN","type":"string","label":"ACKS_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L89"}},{"id":"def-common.AGENT_API_ROUTES.ACTIONS_PATTERN","type":"string","label":"ACTIONS_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L90"}},{"id":"def-common.AGENT_API_ROUTES.ENROLL_PATTERN","type":"string","label":"ENROLL_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":91,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L91"}},{"id":"def-common.AGENT_API_ROUTES.UNENROLL_PATTERN","type":"string","label":"UNENROLL_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L92"}},{"id":"def-common.AGENT_API_ROUTES.BULK_UNENROLL_PATTERN","type":"string","label":"BULK_UNENROLL_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":93,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L93"}},{"id":"def-common.AGENT_API_ROUTES.REASSIGN_PATTERN","type":"string","label":"REASSIGN_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":94,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L94"}},{"id":"def-common.AGENT_API_ROUTES.BULK_REASSIGN_PATTERN","type":"string","label":"BULK_REASSIGN_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L95"}},{"id":"def-common.AGENT_API_ROUTES.STATUS_PATTERN","type":"string","label":"STATUS_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":96,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L96"}},{"id":"def-common.AGENT_API_ROUTES.UPGRADE_PATTERN","type":"string","label":"UPGRADE_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L97"}},{"id":"def-common.AGENT_API_ROUTES.BULK_UPGRADE_PATTERN","type":"string","label":"BULK_UPGRADE_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":98,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L98"}}],"description":[],"label":"AGENT_API_ROUTES","source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L82"},"initialIsOpen":false},{"id":"def-common.AGENT_API_ROUTES_7_9","type":"Object","children":[{"id":"def-common.AGENT_API_ROUTES_7_9.CHECKIN_PATTERN","type":"string","label":"CHECKIN_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L101"}},{"id":"def-common.AGENT_API_ROUTES_7_9.ACKS_PATTERN","type":"string","label":"ACKS_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L102"}},{"id":"def-common.AGENT_API_ROUTES_7_9.ENROLL_PATTERN","type":"string","label":"ENROLL_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L103"}}],"description":[],"label":"AGENT_API_ROUTES_7_9","source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":100,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L100"},"initialIsOpen":false},{"id":"def-common.ENROLLMENT_API_KEY_ROUTES","type":"Object","children":[{"id":"def-common.ENROLLMENT_API_KEY_ROUTES.CREATE_PATTERN","type":"string","label":"CREATE_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":107,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L107"}},{"id":"def-common.ENROLLMENT_API_KEY_ROUTES.LIST_PATTERN","type":"string","label":"LIST_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L108"}},{"id":"def-common.ENROLLMENT_API_KEY_ROUTES.INFO_PATTERN","type":"string","label":"INFO_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":109,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L109"}},{"id":"def-common.ENROLLMENT_API_KEY_ROUTES.DELETE_PATTERN","type":"string","label":"DELETE_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":110,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L110"}}],"description":[],"label":"ENROLLMENT_API_KEY_ROUTES","source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":106,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L106"},"initialIsOpen":false},{"id":"def-common.AGENTS_SETUP_API_ROUTES","type":"Object","children":[{"id":"def-common.AGENTS_SETUP_API_ROUTES.INFO_PATTERN","type":"string","label":"INFO_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L115"}},{"id":"def-common.AGENTS_SETUP_API_ROUTES.CREATE_PATTERN","type":"string","label":"CREATE_PATTERN","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":116,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L116"}}],"description":[],"label":"AGENTS_SETUP_API_ROUTES","source":{"path":"x-pack/plugins/fleet/common/constants/routes.ts","lineNumber":114,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/routes.ts#L114"},"initialIsOpen":false},{"id":"def-common.agentPolicyStatuses","type":"Object","label":"agentPolicyStatuses","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent_policy.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L12"},"signature":["{ readonly Active: \"active\"; readonly Inactive: \"inactive\"; }"],"initialIsOpen":false},{"id":"def-common.DEFAULT_AGENT_POLICY","type":"Object","children":[{"id":"def-common.DEFAULT_AGENT_POLICY.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent_policy.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L21"}},{"id":"def-common.DEFAULT_AGENT_POLICY.namespace","type":"string","label":"namespace","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent_policy.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L22"}},{"id":"def-common.DEFAULT_AGENT_POLICY.description","type":"string","label":"description","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent_policy.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L23"}},{"id":"def-common.DEFAULT_AGENT_POLICY.status","type":"string","label":"status","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent_policy.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L24"},"signature":["\"active\""]},{"id":"def-common.DEFAULT_AGENT_POLICY.package_policies","type":"Array","label":"package_policies","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent_policy.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L25"},"signature":["never[]"]},{"id":"def-common.DEFAULT_AGENT_POLICY.is_default","type":"boolean","label":"is_default","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent_policy.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L26"},"signature":["true"]},{"id":"def-common.DEFAULT_AGENT_POLICY.is_managed","type":"boolean","label":"is_managed","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent_policy.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L27"},"signature":["false"]},{"id":"def-common.DEFAULT_AGENT_POLICY.monitoring_enabled","type":"Array","label":"monitoring_enabled","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent_policy.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L28"},"signature":["(\"metrics\" | \"logs\")[]"]}],"description":[],"label":"DEFAULT_AGENT_POLICY","source":{"path":"x-pack/plugins/fleet/common/constants/agent_policy.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L17"},"initialIsOpen":false},{"id":"def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY","type":"Object","children":[{"id":"def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent_policy.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L35"}},{"id":"def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.namespace","type":"string","label":"namespace","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent_policy.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L36"}},{"id":"def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.description","type":"string","label":"description","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent_policy.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L37"}},{"id":"def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.status","type":"string","label":"status","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent_policy.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L38"},"signature":["\"active\""]},{"id":"def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.package_policies","type":"Array","label":"package_policies","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent_policy.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L39"},"signature":["never[]"]},{"id":"def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.is_default","type":"boolean","label":"is_default","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent_policy.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L40"},"signature":["false"]},{"id":"def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.is_default_fleet_server","type":"boolean","label":"is_default_fleet_server","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent_policy.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L41"},"signature":["true"]},{"id":"def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.is_managed","type":"boolean","label":"is_managed","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent_policy.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L42"},"signature":["false"]},{"id":"def-common.DEFAULT_FLEET_SERVER_AGENT_POLICY.monitoring_enabled","type":"Array","label":"monitoring_enabled","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/agent_policy.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L43"},"signature":["(\"metrics\" | \"logs\")[]"]}],"description":[],"label":"DEFAULT_FLEET_SERVER_AGENT_POLICY","source":{"path":"x-pack/plugins/fleet/common/constants/agent_policy.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/agent_policy.ts#L31"},"initialIsOpen":false},{"id":"def-common.requiredPackages","type":"Object","label":"requiredPackages","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/epm.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/epm.ts#L15"},"signature":["{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; }"],"initialIsOpen":false},{"id":"def-common.defaultPackages","type":"Object","label":"defaultPackages","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/epm.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/epm.ts#L22"},"signature":["{ readonly System: \"system\"; readonly Endpoint: \"endpoint\"; readonly ElasticAgent: \"elastic_agent\"; }"],"initialIsOpen":false},{"id":"def-common.agentAssetTypes","type":"Object","label":"agentAssetTypes","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/epm.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/epm.ts#L24"},"signature":["{ readonly Input: \"input\"; }"],"initialIsOpen":false},{"id":"def-common.dataTypes","type":"Object","label":"dataTypes","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/epm.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/epm.ts#L28"},"signature":["{ readonly Logs: \"logs\"; readonly Metrics: \"metrics\"; }"],"initialIsOpen":false},{"id":"def-common.installationStatuses","type":"Object","label":"installationStatuses","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/epm.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/epm.ts#L33"},"signature":["{ readonly Installed: \"installed\"; readonly NotInstalled: \"not_installed\"; }"],"initialIsOpen":false},{"id":"def-common.outputType","type":"Object","label":"outputType","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/output.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/output.ts#L12"},"signature":["{ readonly Elasticsearch: \"elasticsearch\"; }"],"initialIsOpen":false},{"id":"def-common.DEFAULT_OUTPUT","type":"Object","children":[{"id":"def-common.DEFAULT_OUTPUT.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/output.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/output.ts#L17"}},{"id":"def-common.DEFAULT_OUTPUT.is_default","type":"boolean","label":"is_default","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/output.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/output.ts#L18"},"signature":["true"]},{"id":"def-common.DEFAULT_OUTPUT.type","type":"string","label":"type","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/output.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/output.ts#L19"},"signature":["\"elasticsearch\""]},{"id":"def-common.DEFAULT_OUTPUT.hosts","type":"Array","label":"hosts","description":[],"source":{"path":"x-pack/plugins/fleet/common/constants/output.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/output.ts#L20"},"signature":["string[]"]}],"description":[],"label":"DEFAULT_OUTPUT","source":{"path":"x-pack/plugins/fleet/common/constants/output.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/constants/output.ts#L16"},"initialIsOpen":false},{"id":"def-common.AgentStatusKueryHelper","type":"Object","label":"AgentStatusKueryHelper","description":[],"source":{"path":"x-pack/plugins/fleet/common/services/index.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/index.ts#L9"},"signature":["typeof import(\"/Users/gammon/Elastic/kibana2/x-pack/plugins/fleet/common/services/agent_status\")"],"initialIsOpen":false},{"id":"def-common.epmRouteService","type":"Object","children":[{"id":"def-common.epmRouteService.getCategoriesPath","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"getCategoriesPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L24"},"returnComment":[]},{"id":"def-common.epmRouteService.getListPath","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"getListPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L28"},"returnComment":[]},{"id":"def-common.epmRouteService.getListLimitedPath","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"getListLimitedPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L32"},"returnComment":[]},{"id":"def-common.epmRouteService.getInfoPath","type":"Function","children":[{"type":"string","label":"pkgkey","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L36"}}],"signature":["(pkgkey: string) => string"],"description":[],"label":"getInfoPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L36"},"returnComment":[]},{"id":"def-common.epmRouteService.getStatsPath","type":"Function","children":[{"type":"string","label":"pkgName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L40"}}],"signature":["(pkgName: string) => string"],"description":[],"label":"getStatsPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L40"},"returnComment":[]},{"id":"def-common.epmRouteService.getFilePath","type":"Function","children":[{"type":"string","label":"filePath","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L44"}}],"signature":["(filePath: string) => string"],"description":[],"label":"getFilePath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L44"},"returnComment":[]},{"id":"def-common.epmRouteService.getInstallPath","type":"Function","children":[{"type":"string","label":"pkgkey","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L48"}}],"signature":["(pkgkey: string) => string"],"description":[],"label":"getInstallPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L48"},"returnComment":[]},{"id":"def-common.epmRouteService.getBulkInstallPath","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"getBulkInstallPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L55"},"returnComment":[]},{"id":"def-common.epmRouteService.getRemovePath","type":"Function","children":[{"type":"string","label":"pkgkey","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L59"}}],"signature":["(pkgkey: string) => string"],"description":[],"label":"getRemovePath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L59"},"returnComment":[]}],"description":[],"label":"epmRouteService","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L23"},"initialIsOpen":false},{"id":"def-common.packagePolicyRouteService","type":"Object","children":[{"id":"def-common.packagePolicyRouteService.getListPath","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"getListPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L65"},"returnComment":[]},{"id":"def-common.packagePolicyRouteService.getInfoPath","type":"Function","children":[{"type":"string","label":"packagePolicyId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L69"}}],"signature":["(packagePolicyId: string) => string"],"description":[],"label":"getInfoPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L69"},"returnComment":[]},{"id":"def-common.packagePolicyRouteService.getCreatePath","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"getCreatePath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L73"},"returnComment":[]},{"id":"def-common.packagePolicyRouteService.getUpdatePath","type":"Function","children":[{"type":"string","label":"packagePolicyId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L77"}}],"signature":["(packagePolicyId: string) => string"],"description":[],"label":"getUpdatePath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L77"},"returnComment":[]},{"id":"def-common.packagePolicyRouteService.getDeletePath","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"getDeletePath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L81"},"returnComment":[]}],"description":[],"label":"packagePolicyRouteService","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L64"},"initialIsOpen":false},{"id":"def-common.agentPolicyRouteService","type":"Object","children":[{"id":"def-common.agentPolicyRouteService.getListPath","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"getListPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":87,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L87"},"returnComment":[]},{"id":"def-common.agentPolicyRouteService.getInfoPath","type":"Function","children":[{"type":"string","label":"agentPolicyId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":91,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L91"}}],"signature":["(agentPolicyId: string) => string"],"description":[],"label":"getInfoPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":91,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L91"},"returnComment":[]},{"id":"def-common.agentPolicyRouteService.getCreatePath","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"getCreatePath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L95"},"returnComment":[]},{"id":"def-common.agentPolicyRouteService.getUpdatePath","type":"Function","children":[{"type":"string","label":"agentPolicyId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L99"}}],"signature":["(agentPolicyId: string) => string"],"description":[],"label":"getUpdatePath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L99"},"returnComment":[]},{"id":"def-common.agentPolicyRouteService.getCopyPath","type":"Function","children":[{"type":"string","label":"agentPolicyId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L103"}}],"signature":["(agentPolicyId: string) => string"],"description":[],"label":"getCopyPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L103"},"returnComment":[]},{"id":"def-common.agentPolicyRouteService.getDeletePath","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"getDeletePath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":107,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L107"},"returnComment":[]},{"id":"def-common.agentPolicyRouteService.getInfoFullPath","type":"Function","children":[{"type":"string","label":"agentPolicyId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":111,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L111"}}],"signature":["(agentPolicyId: string) => string"],"description":[],"label":"getInfoFullPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":111,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L111"},"returnComment":[]},{"id":"def-common.agentPolicyRouteService.getInfoFullDownloadPath","type":"Function","children":[{"type":"string","label":"agentPolicyId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L115"}}],"signature":["(agentPolicyId: string) => string"],"description":[],"label":"getInfoFullDownloadPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L115"},"returnComment":[]}],"description":[],"label":"agentPolicyRouteService","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L86"},"initialIsOpen":false},{"id":"def-common.dataStreamRouteService","type":"Object","children":[{"id":"def-common.dataStreamRouteService.getListPath","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"getListPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":124,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L124"},"returnComment":[]}],"description":[],"label":"dataStreamRouteService","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":123,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L123"},"initialIsOpen":false},{"id":"def-common.fleetSetupRouteService","type":"Object","children":[{"id":"def-common.fleetSetupRouteService.getFleetSetupPath","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"getFleetSetupPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":130,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L130"},"returnComment":[]},{"id":"def-common.fleetSetupRouteService.postFleetSetupPath","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"postFleetSetupPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L131"},"returnComment":[]}],"description":[],"label":"fleetSetupRouteService","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":129,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L129"},"initialIsOpen":false},{"id":"def-common.agentRouteService","type":"Object","children":[{"id":"def-common.agentRouteService.getInfoPath","type":"Function","children":[{"type":"string","label":"agentId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":135,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L135"}}],"signature":["(agentId: string) => string"],"description":[],"label":"getInfoPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":135,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L135"},"returnComment":[]},{"id":"def-common.agentRouteService.getUpdatePath","type":"Function","children":[{"type":"string","label":"agentId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":136,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L136"}}],"signature":["(agentId: string) => string"],"description":[],"label":"getUpdatePath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":136,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L136"},"returnComment":[]},{"id":"def-common.agentRouteService.getEventsPath","type":"Function","children":[{"type":"string","label":"agentId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":137,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L137"}}],"signature":["(agentId: string) => string"],"description":[],"label":"getEventsPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":137,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L137"},"returnComment":[]},{"id":"def-common.agentRouteService.getUnenrollPath","type":"Function","children":[{"type":"string","label":"agentId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":138,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L138"}}],"signature":["(agentId: string) => string"],"description":[],"label":"getUnenrollPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":138,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L138"},"returnComment":[]},{"id":"def-common.agentRouteService.getBulkUnenrollPath","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"getBulkUnenrollPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":140,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L140"},"returnComment":[]},{"id":"def-common.agentRouteService.getReassignPath","type":"Function","children":[{"type":"string","label":"agentId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":141,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L141"}}],"signature":["(agentId: string) => string"],"description":[],"label":"getReassignPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":141,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L141"},"returnComment":[]},{"id":"def-common.agentRouteService.getBulkReassignPath","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"getBulkReassignPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":143,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L143"},"returnComment":[]},{"id":"def-common.agentRouteService.getUpgradePath","type":"Function","children":[{"type":"string","label":"agentId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":144,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L144"}}],"signature":["(agentId: string) => string"],"description":[],"label":"getUpgradePath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":144,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L144"},"returnComment":[]},{"id":"def-common.agentRouteService.getBulkUpgradePath","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"getBulkUpgradePath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":146,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L146"},"returnComment":[]},{"id":"def-common.agentRouteService.getListPath","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"getListPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":147,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L147"},"returnComment":[]},{"id":"def-common.agentRouteService.getStatusPath","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"getStatusPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":148,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L148"},"returnComment":[]},{"id":"def-common.agentRouteService.getCreateActionPath","type":"Function","children":[{"type":"string","label":"agentId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":149,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L149"}}],"signature":["(agentId: string) => string"],"description":[],"label":"getCreateActionPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":149,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L149"},"returnComment":[]}],"description":[],"label":"agentRouteService","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":134,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L134"},"initialIsOpen":false},{"id":"def-common.outputRoutesService","type":"Object","children":[{"id":"def-common.outputRoutesService.getInfoPath","type":"Function","children":[{"type":"string","label":"outputId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":154,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L154"}}],"signature":["(outputId: string) => string"],"description":[],"label":"getInfoPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":154,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L154"},"returnComment":[]},{"id":"def-common.outputRoutesService.getUpdatePath","type":"Function","children":[{"type":"string","label":"outputId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":155,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L155"}}],"signature":["(outputId: string) => string"],"description":[],"label":"getUpdatePath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":155,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L155"},"returnComment":[]},{"id":"def-common.outputRoutesService.getListPath","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"getListPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":157,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L157"},"returnComment":[]}],"description":[],"label":"outputRoutesService","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":153,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L153"},"initialIsOpen":false},{"id":"def-common.settingsRoutesService","type":"Object","children":[{"id":"def-common.settingsRoutesService.getInfoPath","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"getInfoPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":161,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L161"},"returnComment":[]},{"id":"def-common.settingsRoutesService.getUpdatePath","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"getUpdatePath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":162,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L162"},"returnComment":[]}],"description":[],"label":"settingsRoutesService","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":160,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L160"},"initialIsOpen":false},{"id":"def-common.appRoutesService","type":"Object","children":[{"id":"def-common.appRoutesService.getCheckPermissionsPath","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"getCheckPermissionsPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":166,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L166"},"returnComment":[]}],"description":[],"label":"appRoutesService","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":165,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L165"},"initialIsOpen":false},{"id":"def-common.enrollmentAPIKeyRouteService","type":"Object","children":[{"id":"def-common.enrollmentAPIKeyRouteService.getListPath","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"getListPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":170,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L170"},"returnComment":[]},{"id":"def-common.enrollmentAPIKeyRouteService.getCreatePath","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"getCreatePath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":171,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L171"},"returnComment":[]},{"id":"def-common.enrollmentAPIKeyRouteService.getInfoPath","type":"Function","children":[{"type":"string","label":"keyId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":172,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L172"}}],"signature":["(keyId: string) => string"],"description":[],"label":"getInfoPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":172,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L172"},"returnComment":[]},{"id":"def-common.enrollmentAPIKeyRouteService.getDeletePath","type":"Function","children":[{"type":"string","label":"keyId","isRequired":true,"signature":["string"],"description":[],"source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":173,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L173"}}],"signature":["(keyId: string) => string"],"description":[],"label":"getDeletePath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":173,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L173"},"returnComment":[]}],"description":[],"label":"enrollmentAPIKeyRouteService","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":169,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L169"},"initialIsOpen":false},{"id":"def-common.setupRouteService","type":"Object","children":[{"id":"def-common.setupRouteService.getSetupPath","type":"Function","children":[],"signature":["() => string"],"description":[],"label":"getSetupPath","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":178,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L178"},"returnComment":[]}],"description":[],"label":"setupRouteService","source":{"path":"x-pack/plugins/fleet/common/services/routes.ts","lineNumber":177,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/fleet/common/services/routes.ts#L177"},"initialIsOpen":false}]}} \ No newline at end of file diff --git a/api_docs/fleet.mdx b/api_docs/fleet.mdx new file mode 100644 index 0000000000000..11c518fb5c5bd --- /dev/null +++ b/api_docs/fleet.mdx @@ -0,0 +1,54 @@ +--- +id: kibFleetPluginApi +slug: /kibana-dev-docs/fleetPluginApi +title: fleet +image: https://source.unsplash.com/400x175/?github +summary: API docs for the fleet plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'fleet'] +--- + +import fleetObj from './fleet.json'; + +## Client + +### Setup + +### Start + +### Objects + +### Functions + +### Interfaces + +### Consts, variables and types + +## Server + +### Setup + +### Start + +### Objects + +### Functions + +### Interfaces + +### Consts, variables and types + +## Common + +### Objects + +### Functions + +### Classes + +### Interfaces + +### Enums + +### Consts, variables and types + diff --git a/api_docs/global_search.json b/api_docs/global_search.json new file mode 100644 index 0000000000000..efd0980293469 --- /dev/null +++ b/api_docs/global_search.json @@ -0,0 +1 @@ +{"id":"globalSearch","client":{"classes":[],"functions":[],"interfaces":[{"id":"def-public.GlobalSearchBatchedResults","type":"Interface","label":"GlobalSearchBatchedResults","description":["\nResponse returned from the {@link GlobalSearchPluginStart | global search service}'s `find` API\n"],"children":[{"id":"def-public.GlobalSearchBatchedResults.results","type":"Array","label":"results","description":["\nResults for this batch"],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L89"},"signature":[{"pluginId":"globalSearch","scope":"common","docId":"kibGlobalSearchPluginApi","section":"def-common.GlobalSearchResult","text":"GlobalSearchResult"},"[]"]}],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":85,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L85"},"initialIsOpen":false},{"id":"def-public.GlobalSearchProviderFindOptions","type":"Interface","label":"GlobalSearchProviderFindOptions","description":["\nOptions provided to {@link GlobalSearchResultProvider | a result provider}'s `find` method."],"children":[{"id":"def-public.GlobalSearchProviderFindOptions.preference","type":"string","label":"preference","description":["\nA custom preference token associated with a search 'session' that should be used to get consistent scoring\nwhen performing calls to ES. Can also be used as a 'session' token for providers returning data from elsewhere\nthan an elasticsearch cluster."],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L20"}},{"id":"def-public.GlobalSearchProviderFindOptions.aborted$","type":"Object","label":"aborted$","description":["\nObservable that emits once if and when the `find` call has been aborted, either manually by the consumer,\nor when the internal timeout period as been reached.\n\nWhen a `find` request is effectively aborted, the service will stop emitting any new result to the consumer anyway, but\nthis can (and should) be used to cancel any pending asynchronous task and complete the result observable from within the provider."],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L28"},"signature":["Observable",""]},{"id":"def-public.GlobalSearchProviderFindOptions.maxResults","type":"number","label":"maxResults","description":["\nThe total maximum number of results (including all batches, not per emission) that should be returned by the provider for a given `find` request.\nAny result emitted exceeding this quota will be ignored by the service and not emitted to the consumer."],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L33"}}],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L14"},"initialIsOpen":false},{"id":"def-public.GlobalSearchProviderResult","type":"Interface","label":"GlobalSearchProviderResult","description":["\nRepresentation of a result returned by a {@link GlobalSearchResultProvider | result provider}"],"children":[{"id":"def-public.GlobalSearchProviderResult.id","type":"string","label":"id","description":["an id that should be unique for an individual provider's results"],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L46"}},{"id":"def-public.GlobalSearchProviderResult.title","type":"string","label":"title","description":["the title/label of the result"],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L48"}},{"id":"def-public.GlobalSearchProviderResult.type","type":"string","label":"type","description":["the type of result"],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L50"}},{"id":"def-public.GlobalSearchProviderResult.icon","type":"string","label":"icon","description":["an optional EUI icon name to associate with the search result"],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L52"},"signature":["string | undefined"]},{"id":"def-public.GlobalSearchProviderResult.url","type":"CompoundType","label":"url","description":["\nThe url associated with this result.\nThis can be either an absolute url, a path relative to the incoming request's basePath, or a structure specifying if the basePath should be prepended.\n"],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L62"},"signature":[{"pluginId":"globalSearch","scope":"common","docId":"kibGlobalSearchPluginApi","section":"def-common.GlobalSearchProviderResultUrl","text":"GlobalSearchProviderResultUrl"}]},{"id":"def-public.GlobalSearchProviderResult.score","type":"number","label":"score","description":["the score of the result, from 1 (lowest) to 100 (highest)"],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L64"}},{"id":"def-public.GlobalSearchProviderResult.meta","type":"Object","label":"meta","description":["an optional record of metadata for this result"],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L66"},"signature":["Record | undefined"]}],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L44"},"initialIsOpen":false},{"id":"def-public.GlobalSearchFindParams","type":"Interface","label":"GlobalSearchFindParams","description":["\nSearch parameters for the {@link GlobalSearchPluginStart.find | `find` API}\n"],"children":[{"id":"def-public.GlobalSearchFindParams.term","type":"string","label":"term","description":["\nThe term to search for. Can be undefined if searching by filters."],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L101"},"signature":["string | undefined"]},{"id":"def-public.GlobalSearchFindParams.types","type":"Array","label":"types","description":["\nThe types of results to search for."],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":105,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L105"},"signature":["string[] | undefined"]},{"id":"def-public.GlobalSearchFindParams.tags","type":"Array","label":"tags","description":["\nThe tag ids to filter search by."],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":109,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L109"},"signature":["string[] | undefined"]}],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L97"},"initialIsOpen":false},{"id":"def-public.GlobalSearchResultProvider","type":"Interface","label":"GlobalSearchResultProvider","description":["\nGlobalSearch result provider, to be registered using the {@link GlobalSearchPluginSetup | global search API}"],"children":[{"id":"def-public.GlobalSearchResultProvider.id","type":"string","label":"id","description":["\nid of the provider"],"source":{"path":"x-pack/plugins/global_search/public/types.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/public/types.ts#L26"}},{"id":"def-public.GlobalSearchResultProvider.find","type":"Function","label":"find","signature":["(search: ",{"pluginId":"globalSearch","scope":"common","docId":"kibGlobalSearchPluginApi","section":"def-common.GlobalSearchFindParams","text":"GlobalSearchFindParams"},", options: ",{"pluginId":"globalSearch","scope":"common","docId":"kibGlobalSearchPluginApi","section":"def-common.GlobalSearchProviderFindOptions","text":"GlobalSearchProviderFindOptions"},") => ","Observable","<",{"pluginId":"globalSearch","scope":"common","docId":"kibGlobalSearchPluginApi","section":"def-common.GlobalSearchProviderResult","text":"GlobalSearchProviderResult"},"[]>"],"description":["\nMethod that should return an observable used to emit new results from the provider.\n\nSee {@GlobalSearchProviderResult | the result type} for the expected result structure.\n"],"children":[{"type":"Object","label":"search","isRequired":true,"signature":[{"pluginId":"globalSearch","scope":"common","docId":"kibGlobalSearchPluginApi","section":"def-common.GlobalSearchFindParams","text":"GlobalSearchFindParams"}],"description":[],"source":{"path":"x-pack/plugins/global_search/public/types.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/public/types.ts#L45"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"globalSearch","scope":"common","docId":"kibGlobalSearchPluginApi","section":"def-common.GlobalSearchProviderFindOptions","text":"GlobalSearchProviderFindOptions"}],"description":[],"source":{"path":"x-pack/plugins/global_search/public/types.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/public/types.ts#L46"}}],"tags":["example"],"returnComment":[],"source":{"path":"x-pack/plugins/global_search/public/types.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/public/types.ts#L44"}},{"id":"def-public.GlobalSearchResultProvider.getSearchableTypes","type":"Function","label":"getSearchableTypes","description":["\nMethod that should return all the possible {@link GlobalSearchProviderResult.type | type} of results that\nthis provider can return."],"source":{"path":"x-pack/plugins/global_search/public/types.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/public/types.ts#L53"},"signature":["() => string[] | Promise"]}],"source":{"path":"x-pack/plugins/global_search/public/types.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/public/types.ts#L22"},"initialIsOpen":false},{"id":"def-public.GlobalSearchFindOptions","type":"Interface","label":"GlobalSearchFindOptions","description":["\nOptions for the server-side {@link GlobalSearchPluginStart.find | find API}"],"children":[{"id":"def-public.GlobalSearchFindOptions.preference","type":"string","label":"preference","description":["\nA custom preference token associated with a search 'session' that should be used to get consistent scoring\nwhen performing calls to ES. Can also be used as a 'session' token for providers returning data from elsewhere\nthan an elasticsearch cluster.\n\nIf not specified, a random token will be generated and used. The token is stored in the sessionStorage and is guaranteed\nto be consistent during a given http 'session'"],"source":{"path":"x-pack/plugins/global_search/public/services/types.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/public/services/types.ts#L22"},"signature":["string | undefined"]},{"id":"def-public.GlobalSearchFindOptions.aborted$","type":"Object","label":"aborted$","description":["\nOptional observable to notify that the associated `find` call should be canceled.\nIf/when provided and emitting, the result observable will be completed and no further result emission will be performed."],"source":{"path":"x-pack/plugins/global_search/public/services/types.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/public/services/types.ts#L27"},"signature":["Observable"," | undefined"]}],"source":{"path":"x-pack/plugins/global_search/public/services/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/public/services/types.ts#L13"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-public.GlobalSearchProviderResultUrl","type":"Type","label":"GlobalSearchProviderResultUrl","description":["\nStructured type for the {@link GlobalSearchProviderResult.url | provider result's url property}"],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L39"},"signature":["string | { path: string; prependBasePath: boolean; }"],"initialIsOpen":false},{"id":"def-public.GlobalSearchResult","type":"Type","label":"GlobalSearchResult","description":["\nRepresentation of a result returned by the {@link GlobalSearchPluginStart.find | `find` API}"],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L72"},"signature":["Pick & { url: string; }"],"initialIsOpen":false},{"id":"def-public.GlobalSearchProviderFindParams","type":"Type","label":"GlobalSearchProviderFindParams","description":[],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L115"},"signature":["GlobalSearchFindParams"],"initialIsOpen":false}],"objects":[],"setup":{"id":"def-public.GlobalSearchPluginSetup","type":"Type","label":"GlobalSearchPluginSetup","description":[],"source":{"path":"x-pack/plugins/global_search/public/types.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/public/types.ts#L16"},"signature":["{ registerResultProvider: (provider: GlobalSearchResultProvider) => void; }"],"lifecycle":"setup","initialIsOpen":true},"start":{"id":"def-public.GlobalSearchPluginStart","type":"Type","label":"GlobalSearchPluginStart","description":[],"source":{"path":"x-pack/plugins/global_search/public/types.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/public/types.ts#L17"},"signature":["{ find: (params: ","GlobalSearchFindParams",", options: ",{"pluginId":"globalSearch","scope":"public","docId":"kibGlobalSearchPluginApi","section":"def-public.GlobalSearchFindOptions","text":"GlobalSearchFindOptions"},") => Observable<","GlobalSearchBatchedResults",">; getSearchableTypes: () => Promise; }"],"lifecycle":"start","initialIsOpen":true}},"server":{"classes":[],"functions":[],"interfaces":[{"id":"def-server.GlobalSearchBatchedResults","type":"Interface","label":"GlobalSearchBatchedResults","description":["\nResponse returned from the {@link GlobalSearchPluginStart | global search service}'s `find` API\n"],"children":[{"id":"def-server.GlobalSearchBatchedResults.results","type":"Array","label":"results","description":["\nResults for this batch"],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L89"},"signature":[{"pluginId":"globalSearch","scope":"common","docId":"kibGlobalSearchPluginApi","section":"def-common.GlobalSearchResult","text":"GlobalSearchResult"},"[]"]}],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":85,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L85"},"initialIsOpen":false},{"id":"def-server.GlobalSearchProviderFindOptions","type":"Interface","label":"GlobalSearchProviderFindOptions","description":["\nOptions provided to {@link GlobalSearchResultProvider | a result provider}'s `find` method."],"children":[{"id":"def-server.GlobalSearchProviderFindOptions.preference","type":"string","label":"preference","description":["\nA custom preference token associated with a search 'session' that should be used to get consistent scoring\nwhen performing calls to ES. Can also be used as a 'session' token for providers returning data from elsewhere\nthan an elasticsearch cluster."],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L20"}},{"id":"def-server.GlobalSearchProviderFindOptions.aborted$","type":"Object","label":"aborted$","description":["\nObservable that emits once if and when the `find` call has been aborted, either manually by the consumer,\nor when the internal timeout period as been reached.\n\nWhen a `find` request is effectively aborted, the service will stop emitting any new result to the consumer anyway, but\nthis can (and should) be used to cancel any pending asynchronous task and complete the result observable from within the provider."],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L28"},"signature":["Observable",""]},{"id":"def-server.GlobalSearchProviderFindOptions.maxResults","type":"number","label":"maxResults","description":["\nThe total maximum number of results (including all batches, not per emission) that should be returned by the provider for a given `find` request.\nAny result emitted exceeding this quota will be ignored by the service and not emitted to the consumer."],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L33"}}],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L14"},"initialIsOpen":false},{"id":"def-server.GlobalSearchProviderResult","type":"Interface","label":"GlobalSearchProviderResult","description":["\nRepresentation of a result returned by a {@link GlobalSearchResultProvider | result provider}"],"children":[{"id":"def-server.GlobalSearchProviderResult.id","type":"string","label":"id","description":["an id that should be unique for an individual provider's results"],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L46"}},{"id":"def-server.GlobalSearchProviderResult.title","type":"string","label":"title","description":["the title/label of the result"],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L48"}},{"id":"def-server.GlobalSearchProviderResult.type","type":"string","label":"type","description":["the type of result"],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L50"}},{"id":"def-server.GlobalSearchProviderResult.icon","type":"string","label":"icon","description":["an optional EUI icon name to associate with the search result"],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L52"},"signature":["string | undefined"]},{"id":"def-server.GlobalSearchProviderResult.url","type":"CompoundType","label":"url","description":["\nThe url associated with this result.\nThis can be either an absolute url, a path relative to the incoming request's basePath, or a structure specifying if the basePath should be prepended.\n"],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L62"},"signature":[{"pluginId":"globalSearch","scope":"common","docId":"kibGlobalSearchPluginApi","section":"def-common.GlobalSearchProviderResultUrl","text":"GlobalSearchProviderResultUrl"}]},{"id":"def-server.GlobalSearchProviderResult.score","type":"number","label":"score","description":["the score of the result, from 1 (lowest) to 100 (highest)"],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L64"}},{"id":"def-server.GlobalSearchProviderResult.meta","type":"Object","label":"meta","description":["an optional record of metadata for this result"],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L66"},"signature":["Record | undefined"]}],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L44"},"initialIsOpen":false},{"id":"def-server.GlobalSearchFindOptions","type":"Interface","label":"GlobalSearchFindOptions","description":["\nOptions for the server-side {@link GlobalSearchPluginStart.find | find API}\n"],"children":[{"id":"def-server.GlobalSearchFindOptions.preference","type":"string","label":"preference","description":["\nA custom preference token associated with a search 'session' that should be used to get consistent scoring\nwhen performing calls to ES. Can also be used as a 'session' token for providers returning data from elsewhere\nthan an elasticsearch cluster.\nIf not specified, a random token will be generated and used."],"source":{"path":"x-pack/plugins/global_search/server/types.ts","lineNumber":95,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L95"},"signature":["string | undefined"]},{"id":"def-server.GlobalSearchFindOptions.aborted$","type":"Object","label":"aborted$","description":["\nOptional observable to notify that the associated `find` call should be canceled.\nIf/when provided and emitting, no further result emission will be performed and the result observable will be completed."],"source":{"path":"x-pack/plugins/global_search/server/types.ts","lineNumber":100,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L100"},"signature":["Observable"," | undefined"]}],"source":{"path":"x-pack/plugins/global_search/server/types.ts","lineNumber":88,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L88"},"initialIsOpen":false},{"id":"def-server.GlobalSearchProviderContext","type":"Interface","label":"GlobalSearchProviderContext","description":["\nContext passed to server-side {@GlobalSearchResultProvider | result provider}'s `find` method.\n"],"children":[{"id":"def-server.GlobalSearchProviderContext.core","type":"Object","label":"core","description":[],"source":{"path":"x-pack/plugins/global_search/server/types.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L66"},"signature":["{ savedObjects: { client: Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectsClient","text":"SavedObjectsClient"},", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\">; typeRegistry: Pick<",{"pluginId":"core","scope":"server","docId":"kibCoreSavedObjectsPluginApi","section":"def-server.SavedObjectTypeRegistry","text":"SavedObjectTypeRegistry"},", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">; }; elasticsearch: { legacy: { client: Pick<",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.LegacyScopedClusterClient","text":"LegacyScopedClusterClient"},", \"callAsCurrentUser\" | \"callAsInternalUser\">; }; }; uiSettings: { client: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.IUiSettingsClient","text":"IUiSettingsClient"},"; }; capabilities: ","Observable"]}],"source":{"path":"x-pack/plugins/global_search/server/types.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L65"},"initialIsOpen":false},{"id":"def-server.GlobalSearchResultProvider","type":"Interface","label":"GlobalSearchResultProvider","description":["\nGlobalSearch result provider, to be registered using the {@link GlobalSearchPluginSetup | global search API}\n"],"children":[{"id":"def-server.GlobalSearchResultProvider.id","type":"string","label":"id","description":["\nid of the provider"],"source":{"path":"x-pack/plugins/global_search/server/types.ts","lineNumber":112,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L112"}},{"id":"def-server.GlobalSearchResultProvider.find","type":"Function","label":"find","signature":["(search: ",{"pluginId":"globalSearch","scope":"common","docId":"kibGlobalSearchPluginApi","section":"def-common.GlobalSearchFindParams","text":"GlobalSearchFindParams"},", options: ",{"pluginId":"globalSearch","scope":"common","docId":"kibGlobalSearchPluginApi","section":"def-common.GlobalSearchProviderFindOptions","text":"GlobalSearchProviderFindOptions"},", context: ",{"pluginId":"globalSearch","scope":"server","docId":"kibGlobalSearchPluginApi","section":"def-server.GlobalSearchProviderContext","text":"GlobalSearchProviderContext"},") => ","Observable","<",{"pluginId":"globalSearch","scope":"common","docId":"kibGlobalSearchPluginApi","section":"def-common.GlobalSearchProviderResult","text":"GlobalSearchProviderResult"}],"description":["\nMethod that should return an observable used to emit new results from the provider.\n\nSee {@GlobalSearchProviderResult | the result type} for the expected result structure.\n"],"children":[{"type":"Object","label":"search","isRequired":true,"signature":[{"pluginId":"globalSearch","scope":"common","docId":"kibGlobalSearchPluginApi","section":"def-common.GlobalSearchFindParams","text":"GlobalSearchFindParams"}],"description":[],"source":{"path":"x-pack/plugins/global_search/server/types.ts","lineNumber":131,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L131"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"globalSearch","scope":"common","docId":"kibGlobalSearchPluginApi","section":"def-common.GlobalSearchProviderFindOptions","text":"GlobalSearchProviderFindOptions"}],"description":[],"source":{"path":"x-pack/plugins/global_search/server/types.ts","lineNumber":132,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L132"}},{"type":"Object","label":"context","isRequired":true,"signature":[{"pluginId":"globalSearch","scope":"server","docId":"kibGlobalSearchPluginApi","section":"def-server.GlobalSearchProviderContext","text":"GlobalSearchProviderContext"}],"description":[],"source":{"path":"x-pack/plugins/global_search/server/types.ts","lineNumber":133,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L133"}}],"tags":["example"],"returnComment":[],"source":{"path":"x-pack/plugins/global_search/server/types.ts","lineNumber":130,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L130"}},{"id":"def-server.GlobalSearchResultProvider.getSearchableTypes","type":"Function","label":"getSearchableTypes","description":["\nMethod that should return all the possible {@link GlobalSearchProviderResult.type | type} of results that\nthis provider can return."],"source":{"path":"x-pack/plugins/global_search/server/types.ts","lineNumber":140,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L140"},"signature":["(context: ",{"pluginId":"globalSearch","scope":"server","docId":"kibGlobalSearchPluginApi","section":"def-server.GlobalSearchProviderContext","text":"GlobalSearchProviderContext"},") => string[] | Promise"]}],"source":{"path":"x-pack/plugins/global_search/server/types.ts","lineNumber":108,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L108"},"initialIsOpen":false},{"id":"def-server.RouteHandlerGlobalSearchContext","type":"Interface","label":"RouteHandlerGlobalSearchContext","description":["\nglobalSearch route handler context.\n"],"children":[{"id":"def-server.RouteHandlerGlobalSearchContext.find","type":"Function","label":"find","signature":["(params: ",{"pluginId":"globalSearch","scope":"common","docId":"kibGlobalSearchPluginApi","section":"def-common.GlobalSearchFindParams","text":"GlobalSearchFindParams"},", options: ",{"pluginId":"globalSearch","scope":"server","docId":"kibGlobalSearchPluginApi","section":"def-server.GlobalSearchFindOptions","text":"GlobalSearchFindOptions"},") => ","Observable","<",{"pluginId":"globalSearch","scope":"common","docId":"kibGlobalSearchPluginApi","section":"def-common.GlobalSearchBatchedResults","text":"GlobalSearchBatchedResults"},">"],"description":["\nSee {@link SearchServiceStart.find | the find API}"],"children":[{"type":"Object","label":"params","isRequired":true,"signature":[{"pluginId":"globalSearch","scope":"common","docId":"kibGlobalSearchPluginApi","section":"def-common.GlobalSearchFindParams","text":"GlobalSearchFindParams"}],"description":[],"source":{"path":"x-pack/plugins/global_search/server/types.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L51"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"globalSearch","scope":"server","docId":"kibGlobalSearchPluginApi","section":"def-server.GlobalSearchFindOptions","text":"GlobalSearchFindOptions"}],"description":[],"source":{"path":"x-pack/plugins/global_search/server/types.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L52"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/global_search/server/types.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L50"}},{"id":"def-server.RouteHandlerGlobalSearchContext.getSearchableTypes","type":"Function","label":"getSearchableTypes","description":["\nSee {@link SearchServiceStart.getSearchableTypes | the getSearchableTypes API}"],"source":{"path":"x-pack/plugins/global_search/server/types.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L57"},"signature":["() => Promise"]}],"source":{"path":"x-pack/plugins/global_search/server/types.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L46"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-server.GlobalSearchProviderResultUrl","type":"Type","label":"GlobalSearchProviderResultUrl","description":["\nStructured type for the {@link GlobalSearchProviderResult.url | provider result's url property}"],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L39"},"signature":["string | { path: string; prependBasePath: boolean; }"],"initialIsOpen":false},{"id":"def-server.GlobalSearchResult","type":"Type","label":"GlobalSearchResult","description":["\nRepresentation of a result returned by the {@link GlobalSearchPluginStart.find | `find` API}"],"source":{"path":"x-pack/plugins/global_search/common/types.ts","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/common/types.ts#L72"},"signature":["Pick & { url: string; }"],"initialIsOpen":false}],"objects":[],"start":{"id":"def-server.GlobalSearchPluginStart","type":"Type","label":"GlobalSearchPluginStart","description":[],"source":{"path":"x-pack/plugins/global_search/server/types.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L28"},"signature":["{ find: (params: GlobalSearchFindParams, options: GlobalSearchFindOptions, request: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},") => Observable; getSearchableTypes: (request: ",{"pluginId":"core","scope":"server","docId":"kibCorePluginApi","section":"def-server.KibanaRequest","text":"KibanaRequest"},") => Promise; }"],"lifecycle":"start","initialIsOpen":true},"setup":{"id":"def-server.GlobalSearchPluginSetup","type":"Type","label":"GlobalSearchPluginSetup","description":[],"source":{"path":"x-pack/plugins/global_search/server/types.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/global_search/server/types.ts#L27"},"signature":["{ registerResultProvider: (provider: GlobalSearchResultProvider) => void; }"],"lifecycle":"setup","initialIsOpen":true}},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]}} \ No newline at end of file diff --git a/api_docs/global_search.mdx b/api_docs/global_search.mdx new file mode 100644 index 0000000000000..387cf195f3cda --- /dev/null +++ b/api_docs/global_search.mdx @@ -0,0 +1,32 @@ +--- +id: kibGlobalSearchPluginApi +slug: /kibana-dev-docs/globalSearchPluginApi +title: globalSearch +image: https://source.unsplash.com/400x175/?github +summary: API docs for the globalSearch plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'globalSearch'] +--- + +import globalSearchObj from './global_search.json'; + +## Client + +### Setup + +### Start + +### Interfaces + +### Consts, variables and types + +## Server + +### Setup + +### Start + +### Interfaces + +### Consts, variables and types + diff --git a/api_docs/home.json b/api_docs/home.json new file mode 100644 index 0000000000000..f91a8c3213911 --- /dev/null +++ b/api_docs/home.json @@ -0,0 +1 @@ +{"id":"home","client":{"classes":[],"functions":[{"id":"def-public.getDisplayText","type":"Function","label":"getDisplayText","signature":["(id: \"ESC\" | \"OSX\" | \"DEB\" | \"RPM\" | \"DOCKER\" | \"WINDOWS\" | \"NODE\" | \"DJANGO\" | \"FLASK\" | \"RAILS\" | \"RACK\" | \"JS\" | \"GO\" | \"JAVA\" | \"DOTNET\" | \"LINUX\" | \"PHP\") => string"],"description":["\nConvert instruction variant id into display text.\n"],"children":[{"type":"CompoundType","label":"id","isRequired":true,"signature":["\"ESC\" | \"OSX\" | \"DEB\" | \"RPM\" | \"DOCKER\" | \"WINDOWS\" | \"NODE\" | \"DJANGO\" | \"FLASK\" | \"RAILS\" | \"RACK\" | \"JS\" | \"GO\" | \"JAVA\" | \"DOTNET\" | \"LINUX\" | \"PHP\""],"description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L55"}}],"tags":["params","return"],"returnComment":["display name"],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L55"},"initialIsOpen":false}],"interfaces":[{"id":"def-public.FeatureCatalogueEntry","type":"Interface","label":"FeatureCatalogueEntry","description":[],"children":[{"id":"def-public.FeatureCatalogueEntry.id","type":"string","label":"id","description":["Unique string identifier for this feature."],"source":{"path":"src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L22"}},{"id":"def-public.FeatureCatalogueEntry.title","type":"string","label":"title","description":["Title of feature displayed to the user."],"source":{"path":"src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L24"}},{"id":"def-public.FeatureCatalogueEntry.category","type":"Enum","label":"category","description":["{@link FeatureCatalogueCategory} to display this feature in."],"source":{"path":"src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L26"},"signature":[{"pluginId":"home","scope":"public","docId":"kibHomePluginApi","section":"def-public.FeatureCatalogueCategory","text":"FeatureCatalogueCategory"}]},{"id":"def-public.FeatureCatalogueEntry.subtitle","type":"string","label":"subtitle","description":["A tagline of feature displayed to the user."],"source":{"path":"src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L28"},"signature":["string | undefined"]},{"id":"def-public.FeatureCatalogueEntry.description","type":"string","label":"description","description":["One-line description of feature displayed to the user."],"source":{"path":"src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L30"}},{"id":"def-public.FeatureCatalogueEntry.icon","type":"CompoundType","label":"icon","description":["EUI `IconType` for icon to be displayed to the user. EUI supports any known EUI icon, SVG URL, or ReactElement."],"source":{"path":"src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L32"},"signature":["IconType"]},{"id":"def-public.FeatureCatalogueEntry.path","type":"string","label":"path","description":["URL path to link to this future. Should not include the basePath."],"source":{"path":"src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L34"}},{"id":"def-public.FeatureCatalogueEntry.showOnHomePage","type":"boolean","label":"showOnHomePage","description":["Whether or not this link should be shown on the front page of Kibana."],"source":{"path":"src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L36"}},{"id":"def-public.FeatureCatalogueEntry.order","type":"number","label":"order","description":["An ordinal used to sort features relative to one another for display on the home page"],"source":{"path":"src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L38"},"signature":["number | undefined"]},{"id":"def-public.FeatureCatalogueEntry.visible","type":"Function","label":"visible","description":["Optional function to control visibility of this feature."],"source":{"path":"src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L40"},"signature":["(() => boolean) | undefined"]},{"id":"def-public.FeatureCatalogueEntry.solutionId","type":"string","label":"solutionId","description":["Unique string identifier of the solution this feature belongs to"],"source":{"path":"src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L42"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L20"},"initialIsOpen":false},{"id":"def-public.FeatureCatalogueSolution","type":"Interface","label":"FeatureCatalogueSolution","description":[],"children":[{"id":"def-public.FeatureCatalogueSolution.id","type":"string","label":"id","description":["Unique string identifier for this solution."],"source":{"path":"src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L48"}},{"id":"def-public.FeatureCatalogueSolution.title","type":"string","label":"title","description":["Title of solution displayed to the user."],"source":{"path":"src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L50"}},{"id":"def-public.FeatureCatalogueSolution.subtitle","type":"string","label":"subtitle","description":["The tagline of the solution displayed to the user."],"source":{"path":"src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L52"}},{"id":"def-public.FeatureCatalogueSolution.description","type":"string","label":"description","description":["One-line description of the solution displayed to the user."],"source":{"path":"src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L54"},"signature":["string | undefined"]},{"id":"def-public.FeatureCatalogueSolution.appDescriptions","type":"Array","label":"appDescriptions","description":["A list of use cases for this solution displayed to the user."],"source":{"path":"src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L56"},"signature":["string[]"]},{"id":"def-public.FeatureCatalogueSolution.icon","type":"CompoundType","label":"icon","description":["EUI `IconType` for icon to be displayed to the user. EUI supports any known EUI icon, SVG URL, or ReactElement."],"source":{"path":"src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L58"},"signature":["IconType"]},{"id":"def-public.FeatureCatalogueSolution.path","type":"string","label":"path","description":["URL path to link to this future. Should not include the basePath."],"source":{"path":"src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L60"}},{"id":"def-public.FeatureCatalogueSolution.order","type":"number","label":"order","description":["An ordinal used to sort solutions relative to one another for display on the home page"],"source":{"path":"src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L62"},"signature":["number | undefined"]}],"source":{"path":"src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L46"},"initialIsOpen":false},{"id":"def-public.Environment","type":"Interface","label":"Environment","description":[],"children":[{"id":"def-public.Environment.cloud","type":"boolean","label":"cloud","description":["\nFlag whether the home app should advertise cloud features"],"source":{"path":"src/plugins/home/public/services/environment/environment.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/environment/environment.ts#L14"}},{"id":"def-public.Environment.apmUi","type":"boolean","label":"apmUi","description":["\nFlag whether the home app should advertise apm features"],"source":{"path":"src/plugins/home/public/services/environment/environment.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/environment/environment.ts#L18"}},{"id":"def-public.Environment.ml","type":"boolean","label":"ml","description":["\nFlag whether the home app should advertise ml features"],"source":{"path":"src/plugins/home/public/services/environment/environment.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/environment/environment.ts#L22"}}],"source":{"path":"src/plugins/home/public/services/environment/environment.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/environment/environment.ts#L10"},"initialIsOpen":false}],"enums":[{"id":"def-public.FeatureCatalogueCategory","type":"Enum","label":"FeatureCatalogueCategory","description":[],"source":{"path":"src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts#L13"},"initialIsOpen":false}],"misc":[{"id":"def-public.FeatureCatalogueSetup","type":"Type","label":"FeatureCatalogueSetup","description":[],"source":{"path":"src/plugins/home/public/plugin.ts","lineNumber":158,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/plugin.ts#L158"},"signature":["{ register: (feature: ",{"pluginId":"home","scope":"public","docId":"kibHomePluginApi","section":"def-public.FeatureCatalogueEntry","text":"FeatureCatalogueEntry"},") => void; registerSolution: (solution: ",{"pluginId":"home","scope":"public","docId":"kibHomePluginApi","section":"def-public.FeatureCatalogueSolution","text":"FeatureCatalogueSolution"},") => void; }"],"initialIsOpen":false},{"id":"def-public.EnvironmentSetup","type":"Type","label":"EnvironmentSetup","description":[],"source":{"path":"src/plugins/home/public/plugin.ts","lineNumber":161,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/plugin.ts#L161"},"signature":["{ update: (update: Partial<",{"pluginId":"home","scope":"public","docId":"kibHomePluginApi","section":"def-public.Environment","text":"Environment"},">) => void; }"],"initialIsOpen":false},{"id":"def-public.TutorialSetup","type":"Type","label":"TutorialSetup","description":[],"source":{"path":"src/plugins/home/public/plugin.ts","lineNumber":164,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/plugin.ts#L164"},"signature":["{ setVariable: (key: string, value: unknown) => void; registerDirectoryNotice: (id: string, component: ","FC","<{}>) => void; registerDirectoryHeaderLink: (id: string, component: ","FC","<{}>) => void; registerModuleNotice: (id: string, component: ","FC","<{ moduleName: string; }>) => void; }"],"initialIsOpen":false},{"id":"def-public.TutorialVariables","type":"Type","label":"TutorialVariables","description":[],"source":{"path":"src/plugins/home/public/services/tutorials/tutorial_service.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/tutorials/tutorial_service.ts#L12"},"signature":["{ [x: string]: unknown; }"],"initialIsOpen":false},{"id":"def-public.TutorialDirectoryNoticeComponent","type":"Type","label":"TutorialDirectoryNoticeComponent","description":[],"source":{"path":"src/plugins/home/public/services/tutorials/tutorial_service.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/tutorials/tutorial_service.ts#L15"},"signature":["(props: { children?: React.ReactNode; }, context: any) => React.ReactElement | null"],"initialIsOpen":false},{"id":"def-public.TutorialDirectoryHeaderLinkComponent","type":"Type","label":"TutorialDirectoryHeaderLinkComponent","description":[],"source":{"path":"src/plugins/home/public/services/tutorials/tutorial_service.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/tutorials/tutorial_service.ts#L18"},"signature":["(props: { children?: React.ReactNode; }, context: any) => React.ReactElement | null"],"initialIsOpen":false},{"id":"def-public.TutorialModuleNoticeComponent","type":"Type","label":"TutorialModuleNoticeComponent","description":[],"source":{"path":"src/plugins/home/public/services/tutorials/tutorial_service.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/services/tutorials/tutorial_service.ts#L21"},"signature":["(props: React.PropsWithChildren<{ moduleName: string; }>, context: any) => React.ReactElement | null"],"initialIsOpen":false}],"objects":[{"id":"def-public.INSTRUCTION_VARIANT","type":"Object","children":[{"id":"def-public.INSTRUCTION_VARIANT.ESC","type":"string","label":"ESC","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L10"}},{"id":"def-public.INSTRUCTION_VARIANT.OSX","type":"string","label":"OSX","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L11"}},{"id":"def-public.INSTRUCTION_VARIANT.DEB","type":"string","label":"DEB","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L12"}},{"id":"def-public.INSTRUCTION_VARIANT.RPM","type":"string","label":"RPM","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L13"}},{"id":"def-public.INSTRUCTION_VARIANT.DOCKER","type":"string","label":"DOCKER","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L14"}},{"id":"def-public.INSTRUCTION_VARIANT.WINDOWS","type":"string","label":"WINDOWS","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L15"}},{"id":"def-public.INSTRUCTION_VARIANT.NODE","type":"string","label":"NODE","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L16"}},{"id":"def-public.INSTRUCTION_VARIANT.DJANGO","type":"string","label":"DJANGO","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L17"}},{"id":"def-public.INSTRUCTION_VARIANT.FLASK","type":"string","label":"FLASK","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L18"}},{"id":"def-public.INSTRUCTION_VARIANT.RAILS","type":"string","label":"RAILS","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L19"}},{"id":"def-public.INSTRUCTION_VARIANT.RACK","type":"string","label":"RACK","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L20"}},{"id":"def-public.INSTRUCTION_VARIANT.JS","type":"string","label":"JS","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L21"}},{"id":"def-public.INSTRUCTION_VARIANT.GO","type":"string","label":"GO","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L22"}},{"id":"def-public.INSTRUCTION_VARIANT.JAVA","type":"string","label":"JAVA","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L23"}},{"id":"def-public.INSTRUCTION_VARIANT.DOTNET","type":"string","label":"DOTNET","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L24"}},{"id":"def-public.INSTRUCTION_VARIANT.LINUX","type":"string","label":"LINUX","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L25"}},{"id":"def-public.INSTRUCTION_VARIANT.PHP","type":"string","label":"PHP","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L26"}}],"description":[],"label":"INSTRUCTION_VARIANT","source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L9"},"initialIsOpen":false}],"setup":{"id":"def-public.HomePublicPluginSetup","type":"Interface","label":"HomePublicPluginSetup","description":[],"children":[{"id":"def-public.HomePublicPluginSetup.tutorials","type":"Object","label":"tutorials","description":[],"source":{"path":"src/plugins/home/public/plugin.ts","lineNumber":168,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/plugin.ts#L168"},"signature":["{ setVariable: (key: string, value: unknown) => void; registerDirectoryNotice: (id: string, component: React.FC<{}>) => void; registerDirectoryHeaderLink: (id: string, component: React.FC<{}>) => void; registerModuleNotice: (id: string, component: React.FC<{ moduleName: string; }>) => void; }"]},{"id":"def-public.HomePublicPluginSetup.featureCatalogue","type":"Object","label":"featureCatalogue","description":[],"source":{"path":"src/plugins/home/public/plugin.ts","lineNumber":169,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/plugin.ts#L169"},"signature":["{ register: (feature: ",{"pluginId":"home","scope":"public","docId":"kibHomePluginApi","section":"def-public.FeatureCatalogueEntry","text":"FeatureCatalogueEntry"},") => void; registerSolution: (solution: ",{"pluginId":"home","scope":"public","docId":"kibHomePluginApi","section":"def-public.FeatureCatalogueSolution","text":"FeatureCatalogueSolution"},") => void; }"]},{"id":"def-public.HomePublicPluginSetup.environment","type":"Object","label":"environment","description":["\nThe environment service is only available for a transition period and will\nbe replaced by display specific extension points."],"source":{"path":"src/plugins/home/public/plugin.ts","lineNumber":176,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/plugin.ts#L176"},"signature":["{ update: (update: Partial<",{"pluginId":"home","scope":"public","docId":"kibHomePluginApi","section":"def-public.Environment","text":"Environment"},">) => void; }"]}],"source":{"path":"src/plugins/home/public/plugin.ts","lineNumber":167,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/plugin.ts#L167"},"lifecycle":"setup","initialIsOpen":true},"start":{"id":"def-public.HomePublicPluginStart","type":"Interface","label":"HomePublicPluginStart","description":[],"children":[{"id":"def-public.HomePublicPluginStart.featureCatalogue","type":"Object","label":"featureCatalogue","description":[],"source":{"path":"src/plugins/home/public/plugin.ts","lineNumber":179,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/plugin.ts#L179"},"signature":[{"pluginId":"home","scope":"public","docId":"kibHomePluginApi","section":"def-public.FeatureCatalogueRegistry","text":"FeatureCatalogueRegistry"}]}],"source":{"path":"src/plugins/home/public/plugin.ts","lineNumber":178,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/public/plugin.ts#L178"},"lifecycle":"start","initialIsOpen":true}},"server":{"classes":[],"functions":[],"interfaces":[{"id":"def-server.ArtifactsSchema","type":"Interface","label":"ArtifactsSchema","description":[],"children":[{"id":"def-server.ArtifactsSchema.exportedFields","type":"Object","label":"exportedFields","description":[],"source":{"path":"src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts#L60"},"signature":["{ documentationUrl: string; } | undefined"]},{"id":"def-server.ArtifactsSchema.dashboards","type":"Array","label":"dashboards","description":[],"source":{"path":"src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts#L63"},"signature":[{"pluginId":"home","scope":"server","docId":"kibHomePluginApi","section":"def-server.DashboardSchema","text":"DashboardSchema"},"[]"]},{"id":"def-server.ArtifactsSchema.application","type":"Object","label":"application","description":[],"source":{"path":"src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts#L64"},"signature":["{ path: string; label: string; } | undefined"]}],"source":{"path":"src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts#L59"},"initialIsOpen":false}],"enums":[{"id":"def-server.TutorialsCategory","type":"Enum","label":"TutorialsCategory","description":[],"source":{"path":"src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts#L13"},"initialIsOpen":false}],"misc":[{"id":"def-server.TutorialProvider","type":"Type","label":"TutorialProvider","description":[],"source":{"path":"src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts","lineNumber":100,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts#L100"},"signature":["(context: ","TutorialContext",") => ","TutorialSchema"],"initialIsOpen":false},{"id":"def-server.SampleDatasetProvider","type":"Type","label":"SampleDatasetProvider","description":[],"source":{"path":"src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts#L82"},"signature":["() => ","SampleDatasetSchema",""],"initialIsOpen":false},{"id":"def-server.SampleDataRegistrySetup","type":"Type","label":"SampleDataRegistrySetup","description":[],"source":{"path":"src/plugins/home/server/services/sample_data/sample_data_registry.ts","lineNumber":168,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/server/services/sample_data/sample_data_registry.ts#L168"},"signature":["{ registerSampleDataset: (specProvider: SampleDatasetProvider) => void; getSampleDatasets: () => SampleDatasetSchema[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: SavedObject[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: AppLinkSchema[]) => void; replacePanelInSampleDatasetDashboard: ({ sampleDataId, dashboardId, oldEmbeddableId, embeddableId, embeddableType, embeddableConfig, }: SampleDatasetDashboardPanel) => void; }"],"initialIsOpen":false}],"objects":[{"id":"def-server.INSTRUCTION_VARIANT","type":"Object","children":[{"id":"def-server.INSTRUCTION_VARIANT.ESC","type":"string","label":"ESC","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L10"}},{"id":"def-server.INSTRUCTION_VARIANT.OSX","type":"string","label":"OSX","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L11"}},{"id":"def-server.INSTRUCTION_VARIANT.DEB","type":"string","label":"DEB","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L12"}},{"id":"def-server.INSTRUCTION_VARIANT.RPM","type":"string","label":"RPM","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L13"}},{"id":"def-server.INSTRUCTION_VARIANT.DOCKER","type":"string","label":"DOCKER","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L14"}},{"id":"def-server.INSTRUCTION_VARIANT.WINDOWS","type":"string","label":"WINDOWS","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L15"}},{"id":"def-server.INSTRUCTION_VARIANT.NODE","type":"string","label":"NODE","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L16"}},{"id":"def-server.INSTRUCTION_VARIANT.DJANGO","type":"string","label":"DJANGO","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L17"}},{"id":"def-server.INSTRUCTION_VARIANT.FLASK","type":"string","label":"FLASK","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L18"}},{"id":"def-server.INSTRUCTION_VARIANT.RAILS","type":"string","label":"RAILS","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L19"}},{"id":"def-server.INSTRUCTION_VARIANT.RACK","type":"string","label":"RACK","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L20"}},{"id":"def-server.INSTRUCTION_VARIANT.JS","type":"string","label":"JS","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L21"}},{"id":"def-server.INSTRUCTION_VARIANT.GO","type":"string","label":"GO","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L22"}},{"id":"def-server.INSTRUCTION_VARIANT.JAVA","type":"string","label":"JAVA","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L23"}},{"id":"def-server.INSTRUCTION_VARIANT.DOTNET","type":"string","label":"DOTNET","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L24"}},{"id":"def-server.INSTRUCTION_VARIANT.LINUX","type":"string","label":"LINUX","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L25"}},{"id":"def-server.INSTRUCTION_VARIANT.PHP","type":"string","label":"PHP","description":[],"source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L26"}}],"description":[],"label":"INSTRUCTION_VARIANT","source":{"path":"src/plugins/home/common/instruction_variant.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/common/instruction_variant.ts#L9"},"initialIsOpen":false}],"setup":{"id":"def-server.HomeServerPluginSetup","type":"Interface","label":"HomeServerPluginSetup","description":[],"children":[{"id":"def-server.HomeServerPluginSetup.tutorials","type":"Object","label":"tutorials","description":[],"source":{"path":"src/plugins/home/server/plugin.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/server/plugin.ts#L55"},"signature":["{ registerTutorial: (specProvider: ",{"pluginId":"home","scope":"server","docId":"kibHomePluginApi","section":"def-server.TutorialProvider","text":"TutorialProvider"},") => void; unregisterTutorial: (specProvider: ",{"pluginId":"home","scope":"server","docId":"kibHomePluginApi","section":"def-server.TutorialProvider","text":"TutorialProvider"},") => void; addScopedTutorialContextFactory: (scopedTutorialContextFactory: ",{"pluginId":"home","scope":"server","docId":"kibHomePluginApi","section":"def-server.ScopedTutorialContextFactory","text":"ScopedTutorialContextFactory"},") => void; }"]},{"id":"def-server.HomeServerPluginSetup.sampleData","type":"Object","label":"sampleData","description":[],"source":{"path":"src/plugins/home/server/plugin.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/server/plugin.ts#L56"},"signature":["{ registerSampleDataset: (specProvider: ",{"pluginId":"home","scope":"server","docId":"kibHomePluginApi","section":"def-server.SampleDatasetProvider","text":"SampleDatasetProvider"},") => void; getSampleDatasets: () => ",{"pluginId":"home","scope":"server","docId":"kibHomePluginApi","section":"def-server.SampleDatasetSchema","text":"SampleDatasetSchema"},"[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ",{"pluginId":"core","scope":"common","docId":"kibCorePluginApi","section":"def-common.SavedObject","text":"SavedObject"},"[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: ",{"pluginId":"home","scope":"server","docId":"kibHomePluginApi","section":"def-server.AppLinkSchema","text":"AppLinkSchema"},"[]) => void; replacePanelInSampleDatasetDashboard: ({ sampleDataId, dashboardId, oldEmbeddableId, embeddableId, embeddableType, embeddableConfig, }: ",{"pluginId":"home","scope":"server","docId":"kibHomePluginApi","section":"def-server.SampleDatasetDashboardPanel","text":"SampleDatasetDashboardPanel"}]}],"source":{"path":"src/plugins/home/server/plugin.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/server/plugin.ts#L54"},"lifecycle":"setup","initialIsOpen":true},"start":{"id":"def-server.HomeServerPluginStart","type":"Interface","label":"HomeServerPluginStart","description":[],"children":[{"id":"def-server.HomeServerPluginStart.tutorials","type":"Object","label":"tutorials","description":[],"source":{"path":"src/plugins/home/server/plugin.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/server/plugin.ts#L61"},"signature":["{}"]},{"id":"def-server.HomeServerPluginStart.sampleData","type":"Object","label":"sampleData","description":[],"source":{"path":"src/plugins/home/server/plugin.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/server/plugin.ts#L62"},"signature":["{}"]}],"source":{"path":"src/plugins/home/server/plugin.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/home/server/plugin.ts#L60"},"lifecycle":"start","initialIsOpen":true}},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]}} \ No newline at end of file diff --git a/api_docs/home.mdx b/api_docs/home.mdx new file mode 100644 index 0000000000000..62734b8822fff --- /dev/null +++ b/api_docs/home.mdx @@ -0,0 +1,42 @@ +--- +id: kibHomePluginApi +slug: /kibana-dev-docs/homePluginApi +title: home +image: https://source.unsplash.com/400x175/?github +summary: API docs for the home plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'home'] +--- + +import homeObj from './home.json'; + +## Client + +### Setup + +### Start + +### Objects + +### Functions + +### Interfaces + +### Enums + +### Consts, variables and types + +## Server + +### Setup + +### Start + +### Objects + +### Interfaces + +### Enums + +### Consts, variables and types + diff --git a/api_docs/index_lifecycle_management.json b/api_docs/index_lifecycle_management.json new file mode 100644 index 0000000000000..e69299b543536 --- /dev/null +++ b/api_docs/index_lifecycle_management.json @@ -0,0 +1 @@ +{"id":"indexLifecycleManagement","client":{"classes":[],"functions":[],"interfaces":[{"id":"def-public.IlmUrlGeneratorState","type":"Interface","label":"IlmUrlGeneratorState","description":[],"children":[{"id":"def-public.IlmUrlGeneratorState.page","type":"CompoundType","label":"page","description":[],"source":{"path":"x-pack/plugins/index_lifecycle_management/public/url_generator.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_lifecycle_management/public/url_generator.ts#L22"},"signature":["\"policies_list\" | \"policy_edit\" | \"policy_create\""]},{"id":"def-public.IlmUrlGeneratorState.policyName","type":"string","label":"policyName","description":[],"source":{"path":"x-pack/plugins/index_lifecycle_management/public/url_generator.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_lifecycle_management/public/url_generator.ts#L23"},"signature":["string | undefined"]},{"id":"def-public.IlmUrlGeneratorState.absolute","type":"CompoundType","label":"absolute","description":[],"source":{"path":"x-pack/plugins/index_lifecycle_management/public/url_generator.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_lifecycle_management/public/url_generator.ts#L24"},"signature":["boolean | undefined"]}],"source":{"path":"x-pack/plugins/index_lifecycle_management/public/url_generator.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_lifecycle_management/public/url_generator.ts#L21"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-public.ILM_URL_GENERATOR_ID","type":"string","label":"ILM_URL_GENERATOR_ID","description":[],"source":{"path":"x-pack/plugins/index_lifecycle_management/public/url_generator.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_lifecycle_management/public/url_generator.ts#L19"},"signature":["\"ILM_URL_GENERATOR_ID\""],"initialIsOpen":false}],"objects":[]},"server":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]}} \ No newline at end of file diff --git a/api_docs/index_lifecycle_management.mdx b/api_docs/index_lifecycle_management.mdx new file mode 100644 index 0000000000000..11bb760bf73cc --- /dev/null +++ b/api_docs/index_lifecycle_management.mdx @@ -0,0 +1,18 @@ +--- +id: kibIndexLifecycleManagementPluginApi +slug: /kibana-dev-docs/indexLifecycleManagementPluginApi +title: indexLifecycleManagement +image: https://source.unsplash.com/400x175/?github +summary: API docs for the indexLifecycleManagement plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexLifecycleManagement'] +--- + +import indexLifecycleManagementObj from './index_lifecycle_management.json'; + +## Client + +### Interfaces + +### Consts, variables and types + diff --git a/api_docs/index_management.json b/api_docs/index_management.json new file mode 100644 index 0000000000000..e95b86af8fc2f --- /dev/null +++ b/api_docs/index_management.json @@ -0,0 +1 @@ +{"id":"indexManagement","client":{"classes":[],"functions":[{"id":"def-public.getIndexListUri","type":"Function","children":[{"type":"string","label":"filter","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"x-pack/plugins/index_management/public/application/services/routing.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/public/application/services/routing.ts#L38"}},{"type":"CompoundType","label":"includeHiddenIndices","isRequired":false,"signature":["boolean | undefined"],"description":[],"source":{"path":"x-pack/plugins/index_management/public/application/services/routing.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/public/application/services/routing.ts#L38"}}],"signature":["(filter?: string | undefined, includeHiddenIndices?: boolean | undefined) => string"],"description":[],"label":"getIndexListUri","source":{"path":"x-pack/plugins/index_management/public/application/services/routing.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/public/application/services/routing.ts#L38"},"returnComment":[],"initialIsOpen":false}],"interfaces":[{"id":"def-public.IndexManagementPluginSetup","type":"Interface","label":"IndexManagementPluginSetup","description":[],"children":[{"id":"def-public.IndexManagementPluginSetup.extensionsService","type":"Object","label":"extensionsService","description":[],"source":{"path":"x-pack/plugins/index_management/public/types.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/public/types.ts#L14"},"signature":[{"pluginId":"indexManagement","scope":"public","docId":"kibIndexManagementPluginApi","section":"def-public.ExtensionsSetup","text":"ExtensionsSetup"}]}],"source":{"path":"x-pack/plugins/index_management/public/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/public/types.ts#L13"},"initialIsOpen":false},{"id":"def-public.Index","type":"Interface","label":"Index","description":[],"children":[{"id":"def-public.Index.health","type":"string","label":"health","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L55"}},{"id":"def-public.Index.status","type":"string","label":"status","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L56"}},{"id":"def-public.Index.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L57"}},{"id":"def-public.Index.uuid","type":"string","label":"uuid","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L58"}},{"id":"def-public.Index.primary","type":"string","label":"primary","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L59"}},{"id":"def-public.Index.replica","type":"string","label":"replica","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L60"}},{"id":"def-public.Index.documents","type":"Any","label":"documents","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L61"},"signature":["any"]},{"id":"def-public.Index.size","type":"Any","label":"size","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L62"},"signature":["any"]},{"id":"def-public.Index.isFrozen","type":"boolean","label":"isFrozen","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L63"}},{"id":"def-public.Index.aliases","type":"CompoundType","label":"aliases","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L64"},"signature":["string | string[]"]},{"id":"def-public.Index.data_stream","type":"string","label":"data_stream","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L65"},"signature":["string | undefined"]},{"id":"def-public.Index.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L66"},"signature":["any"]}],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L54"},"initialIsOpen":false}],"enums":[],"misc":[],"objects":[]},"server":{"classes":[],"functions":[],"interfaces":[{"id":"def-server.Dependencies","type":"Interface","label":"Dependencies","description":[],"children":[{"id":"def-server.Dependencies.security","type":"Object","label":"security","description":[],"source":{"path":"x-pack/plugins/index_management/server/types.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/server/types.ts#L21"},"signature":[{"pluginId":"security","scope":"server","docId":"kibSecurityPluginApi","section":"def-server.SecurityPluginSetup","text":"SecurityPluginSetup"}]},{"id":"def-server.Dependencies.licensing","type":"Object","label":"licensing","description":[],"source":{"path":"x-pack/plugins/index_management/server/types.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/server/types.ts#L22"},"signature":[{"pluginId":"licensing","scope":"server","docId":"kibLicensingPluginApi","section":"def-server.LicensingPluginSetup","text":"LicensingPluginSetup"}]},{"id":"def-server.Dependencies.features","type":"Object","label":"features","description":[],"source":{"path":"x-pack/plugins/index_management/server/types.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/server/types.ts#L23"},"signature":[{"pluginId":"features","scope":"server","docId":"kibFeaturesPluginApi","section":"def-server.PluginSetupContract","text":"PluginSetupContract"}]}],"source":{"path":"x-pack/plugins/index_management/server/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/server/types.ts#L20"},"initialIsOpen":false},{"id":"def-server.Index","type":"Interface","label":"Index","description":[],"children":[{"id":"def-server.Index.health","type":"string","label":"health","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L55"}},{"id":"def-server.Index.status","type":"string","label":"status","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L56"}},{"id":"def-server.Index.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L57"}},{"id":"def-server.Index.uuid","type":"string","label":"uuid","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L58"}},{"id":"def-server.Index.primary","type":"string","label":"primary","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L59"}},{"id":"def-server.Index.replica","type":"string","label":"replica","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L60"}},{"id":"def-server.Index.documents","type":"Any","label":"documents","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L61"},"signature":["any"]},{"id":"def-server.Index.size","type":"Any","label":"size","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L62"},"signature":["any"]},{"id":"def-server.Index.isFrozen","type":"boolean","label":"isFrozen","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L63"}},{"id":"def-server.Index.aliases","type":"CompoundType","label":"aliases","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L64"},"signature":["string | string[]"]},{"id":"def-server.Index.data_stream","type":"string","label":"data_stream","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L65"},"signature":["string | undefined"]},{"id":"def-server.Index.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L66"},"signature":["any"]}],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L54"},"initialIsOpen":false},{"id":"def-server.LegacyTemplateSerialized","type":"Interface","label":"LegacyTemplateSerialized","description":["\n------------------------------------------\n--------- LEGACY INDEX TEMPLATES ---------\n------------------------------------------"],"children":[{"id":"def-server.LegacyTemplateSerialized.index_patterns","type":"Array","label":"index_patterns","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":100,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L100"},"signature":["string[]"]},{"id":"def-server.LegacyTemplateSerialized.version","type":"number","label":"version","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L101"},"signature":["number | undefined"]},{"id":"def-server.LegacyTemplateSerialized.settings","type":"Object","label":"settings","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L102"},"signature":[{"pluginId":"indexManagement","scope":"common","docId":"kibIndexManagementPluginApi","section":"def-common.IndexSettings","text":"IndexSettings"}," | undefined"]},{"id":"def-server.LegacyTemplateSerialized.aliases","type":"Object","label":"aliases","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L103"},"signature":[{"pluginId":"indexManagement","scope":"common","docId":"kibIndexManagementPluginApi","section":"def-common.Aliases","text":"Aliases"}," | undefined"]},{"id":"def-server.LegacyTemplateSerialized.mappings","type":"Object","label":"mappings","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L104"},"signature":[{"pluginId":"indexManagement","scope":"common","docId":"kibIndexManagementPluginApi","section":"def-common.Mappings","text":"Mappings"}," | undefined"]},{"id":"def-server.LegacyTemplateSerialized.order","type":"number","label":"order","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":105,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L105"},"signature":["number | undefined"]}],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L99"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-server.IndexManagementConfig","type":"Type","label":"IndexManagementConfig","description":[],"source":{"path":"x-pack/plugins/index_management/server/config.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/server/config.ts#L14"},"signature":["{ readonly enabled: boolean; }"],"initialIsOpen":false}],"objects":[],"setup":{"id":"def-server.IndexManagementPluginSetup","type":"Interface","label":"IndexManagementPluginSetup","description":[],"children":[{"id":"def-server.IndexManagementPluginSetup.indexDataEnricher","type":"Object","label":"indexDataEnricher","description":[],"source":{"path":"x-pack/plugins/index_management/server/plugin.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/server/plugin.ts#L26"},"signature":["{ add: (enricher: ",{"pluginId":"indexManagement","scope":"server","docId":"kibIndexManagementPluginApi","section":"def-server.Enricher","text":"Enricher"},") => void; }"]}],"source":{"path":"x-pack/plugins/index_management/server/plugin.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/server/plugin.ts#L25"},"lifecycle":"setup","initialIsOpen":true}},"common":{"classes":[],"functions":[{"id":"def-common.getTemplateParameter","type":"Function","children":[{"type":"CompoundType","label":"template","isRequired":true,"signature":[{"pluginId":"indexManagement","scope":"common","docId":"kibIndexManagementPluginApi","section":"def-common.LegacyTemplateSerialized","text":"LegacyTemplateSerialized"}," | ",{"pluginId":"indexManagement","scope":"common","docId":"kibIndexManagementPluginApi","section":"def-common.TemplateSerialized","text":"TemplateSerialized"}],"description":[],"source":{"path":"x-pack/plugins/index_management/common/lib/utils.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/lib/utils.ts#L22"}},{"type":"CompoundType","label":"setting","isRequired":true,"signature":["\"aliases\" | \"settings\" | \"mappings\""],"description":[],"source":{"path":"x-pack/plugins/index_management/common/lib/utils.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/lib/utils.ts#L23"}}],"signature":["(template: ",{"pluginId":"indexManagement","scope":"common","docId":"kibIndexManagementPluginApi","section":"def-common.LegacyTemplateSerialized","text":"LegacyTemplateSerialized"}," | ",{"pluginId":"indexManagement","scope":"common","docId":"kibIndexManagementPluginApi","section":"def-common.TemplateSerialized","text":"TemplateSerialized"},", setting: \"aliases\" | \"settings\" | \"mappings\") => ",{"pluginId":"indexManagement","scope":"common","docId":"kibIndexManagementPluginApi","section":"def-common.Aliases","text":"Aliases"}," | undefined"],"description":[],"label":"getTemplateParameter","source":{"path":"x-pack/plugins/index_management/common/lib/utils.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/lib/utils.ts#L21"},"returnComment":[],"initialIsOpen":false}],"interfaces":[{"id":"def-common.DataStreamFromEs","type":"Interface","label":"DataStreamFromEs","description":[],"children":[{"id":"def-common.DataStreamFromEs.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L31"}},{"id":"def-common.DataStreamFromEs.timestamp_field","type":"Object","label":"timestamp_field","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L32"},"signature":["TimestampFieldFromEs"]},{"id":"def-common.DataStreamFromEs.indices","type":"Array","label":"indices","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L33"},"signature":[{"pluginId":"indexManagement","scope":"common","docId":"kibIndexManagementPluginApi","section":"def-common.DataStreamIndexFromEs","text":"DataStreamIndexFromEs"},"[]"]},{"id":"def-common.DataStreamFromEs.generation","type":"number","label":"generation","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L34"}},{"id":"def-common.DataStreamFromEs._meta","type":"Object","label":"_meta","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L35"},"signature":["MetaFromEs | undefined"]},{"id":"def-common.DataStreamFromEs.status","type":"CompoundType","label":"status","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L36"},"signature":[{"pluginId":"indexManagement","scope":"common","docId":"kibIndexManagementPluginApi","section":"def-common.HealthFromEs","text":"HealthFromEs"}]},{"id":"def-common.DataStreamFromEs.template","type":"string","label":"template","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L37"}},{"id":"def-common.DataStreamFromEs.ilm_policy","type":"string","label":"ilm_policy","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L38"},"signature":["string | undefined"]},{"id":"def-common.DataStreamFromEs.store_size","type":"string","label":"store_size","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L39"},"signature":["string | undefined"]},{"id":"def-common.DataStreamFromEs.store_size_bytes","type":"number","label":"store_size_bytes","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L40"},"signature":["number | undefined"]},{"id":"def-common.DataStreamFromEs.maximum_timestamp","type":"number","label":"maximum_timestamp","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L41"},"signature":["number | undefined"]},{"id":"def-common.DataStreamFromEs.privileges","type":"Object","label":"privileges","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L42"},"signature":["PrivilegesFromEs"]},{"id":"def-common.DataStreamFromEs.hidden","type":"boolean","label":"hidden","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L43"}}],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L30"},"initialIsOpen":false},{"id":"def-common.DataStream","type":"Interface","label":"DataStream","description":[],"children":[{"id":"def-common.DataStream.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L54"}},{"id":"def-common.DataStream.timeStampField","type":"Object","label":"timeStampField","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L55"},"signature":["TimestampFieldFromEs"]},{"id":"def-common.DataStream.indices","type":"Array","label":"indices","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L56"},"signature":[{"pluginId":"indexManagement","scope":"common","docId":"kibIndexManagementPluginApi","section":"def-common.DataStreamIndex","text":"DataStreamIndex"},"[]"]},{"id":"def-common.DataStream.generation","type":"number","label":"generation","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L57"}},{"id":"def-common.DataStream.health","type":"CompoundType","label":"health","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L58"},"signature":[{"pluginId":"indexManagement","scope":"common","docId":"kibIndexManagementPluginApi","section":"def-common.Health","text":"Health"}]},{"id":"def-common.DataStream.indexTemplateName","type":"string","label":"indexTemplateName","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L59"}},{"id":"def-common.DataStream.ilmPolicyName","type":"string","label":"ilmPolicyName","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L60"},"signature":["string | undefined"]},{"id":"def-common.DataStream.storageSize","type":"string","label":"storageSize","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L61"},"signature":["string | undefined"]},{"id":"def-common.DataStream.storageSizeBytes","type":"number","label":"storageSizeBytes","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L62"},"signature":["number | undefined"]},{"id":"def-common.DataStream.maxTimeStamp","type":"number","label":"maxTimeStamp","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L63"},"signature":["number | undefined"]},{"id":"def-common.DataStream._meta","type":"Object","label":"_meta","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L64"},"signature":["MetaFromEs | undefined"]},{"id":"def-common.DataStream.privileges","type":"Object","label":"privileges","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L65"},"signature":["PrivilegesFromEs"]},{"id":"def-common.DataStream.hidden","type":"boolean","label":"hidden","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L66"}}],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L53"},"initialIsOpen":false},{"id":"def-common.DataStreamIndex","type":"Interface","label":"DataStreamIndex","description":[],"children":[{"id":"def-common.DataStreamIndex.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":70,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L70"}},{"id":"def-common.DataStreamIndex.uuid","type":"string","label":"uuid","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L71"}}],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":69,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L69"},"initialIsOpen":false},{"id":"def-common.Aliases","type":"Interface","label":"Aliases","description":[],"children":[{"id":"def-common.Aliases.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/aliases.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/aliases.ts#L9"},"signature":["any"]}],"source":{"path":"x-pack/plugins/index_management/common/types/aliases.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/aliases.ts#L8"},"initialIsOpen":false},{"id":"def-common.IndexSettings","type":"Interface","label":"IndexSettings","description":[],"children":[{"id":"def-common.IndexSettings.index","type":"Object","label":"index","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L49"},"signature":["Partial | undefined"]},{"id":"def-common.IndexSettings.analysis","type":"Object","label":"analysis","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L50"},"signature":["AnalysisModule | undefined"]},{"id":"def-common.IndexSettings.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L51"},"signature":["any"]}],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L48"},"initialIsOpen":false},{"id":"def-common.Index","type":"Interface","label":"Index","description":[],"children":[{"id":"def-common.Index.health","type":"string","label":"health","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L55"}},{"id":"def-common.Index.status","type":"string","label":"status","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L56"}},{"id":"def-common.Index.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L57"}},{"id":"def-common.Index.uuid","type":"string","label":"uuid","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":58,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L58"}},{"id":"def-common.Index.primary","type":"string","label":"primary","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L59"}},{"id":"def-common.Index.replica","type":"string","label":"replica","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L60"}},{"id":"def-common.Index.documents","type":"Any","label":"documents","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L61"},"signature":["any"]},{"id":"def-common.Index.size","type":"Any","label":"size","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L62"},"signature":["any"]},{"id":"def-common.Index.isFrozen","type":"boolean","label":"isFrozen","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L63"}},{"id":"def-common.Index.aliases","type":"CompoundType","label":"aliases","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L64"},"signature":["string | string[]"]},{"id":"def-common.Index.data_stream","type":"string","label":"data_stream","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L65"},"signature":["string | undefined"]},{"id":"def-common.Index.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L66"},"signature":["any"]}],"source":{"path":"x-pack/plugins/index_management/common/types/indices.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/indices.ts#L54"},"initialIsOpen":false},{"id":"def-common.Mappings","type":"Interface","label":"Mappings","description":[],"children":[{"id":"def-common.Mappings.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/mappings.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/mappings.ts#L11"},"signature":["any"]}],"source":{"path":"x-pack/plugins/index_management/common/types/mappings.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/mappings.ts#L10"},"initialIsOpen":false},{"id":"def-common.TemplateSerialized","type":"Interface","label":"TemplateSerialized","description":["\nIndex template format from Elasticsearch"],"children":[{"id":"def-common.TemplateSerialized.index_patterns","type":"Array","label":"index_patterns","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L16"},"signature":["string[]"]},{"id":"def-common.TemplateSerialized.template","type":"Object","label":"template","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L17"},"signature":["{ settings?: ",{"pluginId":"indexManagement","scope":"common","docId":"kibIndexManagementPluginApi","section":"def-common.IndexSettings","text":"IndexSettings"}," | undefined; aliases?: ",{"pluginId":"indexManagement","scope":"common","docId":"kibIndexManagementPluginApi","section":"def-common.Aliases","text":"Aliases"}," | undefined; mappings?: ",{"pluginId":"indexManagement","scope":"common","docId":"kibIndexManagementPluginApi","section":"def-common.Mappings","text":"Mappings"}," | undefined; } | undefined"]},{"id":"def-common.TemplateSerialized.composed_of","type":"Array","label":"composed_of","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L22"},"signature":["string[] | undefined"]},{"id":"def-common.TemplateSerialized.version","type":"number","label":"version","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L23"},"signature":["number | undefined"]},{"id":"def-common.TemplateSerialized.priority","type":"number","label":"priority","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L24"},"signature":["number | undefined"]},{"id":"def-common.TemplateSerialized._meta","type":"Object","label":"_meta","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L25"},"signature":["{ [key: string]: any; } | undefined"]},{"id":"def-common.TemplateSerialized.data_stream","type":"Object","label":"data_stream","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L26"},"signature":["{} | undefined"]}],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L15"},"initialIsOpen":false},{"id":"def-common.TemplateDeserialized","type":"Interface","label":"TemplateDeserialized","description":["\nTemplateDeserialized is the format the UI will be working with,\nregardless if we are loading the new format (composable) index template,\nor the legacy one. Serialization is done server side."],"children":[{"id":"def-common.TemplateDeserialized.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L35"}},{"id":"def-common.TemplateDeserialized.indexPatterns","type":"Array","label":"indexPatterns","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L36"},"signature":["string[]"]},{"id":"def-common.TemplateDeserialized.template","type":"Object","label":"template","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L37"},"signature":["{ settings?: ",{"pluginId":"indexManagement","scope":"common","docId":"kibIndexManagementPluginApi","section":"def-common.IndexSettings","text":"IndexSettings"}," | undefined; aliases?: ",{"pluginId":"indexManagement","scope":"common","docId":"kibIndexManagementPluginApi","section":"def-common.Aliases","text":"Aliases"}," | undefined; mappings?: ",{"pluginId":"indexManagement","scope":"common","docId":"kibIndexManagementPluginApi","section":"def-common.Mappings","text":"Mappings"}," | undefined; } | undefined"]},{"id":"def-common.TemplateDeserialized.composedOf","type":"Array","label":"composedOf","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L42"},"signature":["string[] | undefined"]},{"id":"def-common.TemplateDeserialized.version","type":"number","label":"version","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L43"},"signature":["number | undefined"]},{"id":"def-common.TemplateDeserialized.priority","type":"number","label":"priority","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L44"},"signature":["number | undefined"]},{"id":"def-common.TemplateDeserialized.order","type":"number","label":"order","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L45"},"signature":["number | undefined"]},{"id":"def-common.TemplateDeserialized.ilmPolicy","type":"Object","label":"ilmPolicy","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L46"},"signature":["{ name: string; } | undefined"]},{"id":"def-common.TemplateDeserialized._meta","type":"Object","label":"_meta","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L49"},"signature":["{ [key: string]: any; } | undefined"]},{"id":"def-common.TemplateDeserialized.dataStream","type":"Object","label":"dataStream","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L51"},"signature":["{ [key: string]: any; hidden?: boolean | undefined; } | undefined"]},{"id":"def-common.TemplateDeserialized._kbnMeta","type":"Object","label":"_kbnMeta","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L55"},"signature":["{ type: ",{"pluginId":"indexManagement","scope":"common","docId":"kibIndexManagementPluginApi","section":"def-common.TemplateType","text":"TemplateType"},"; hasDatastream: boolean; isLegacy?: boolean | undefined; }"]}],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L34"},"initialIsOpen":false},{"id":"def-common.TemplateFromEs","type":"Interface","label":"TemplateFromEs","description":[],"children":[{"id":"def-common.TemplateFromEs.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L65"}},{"id":"def-common.TemplateFromEs.index_template","type":"Object","label":"index_template","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L66"},"signature":[{"pluginId":"indexManagement","scope":"common","docId":"kibIndexManagementPluginApi","section":"def-common.TemplateSerialized","text":"TemplateSerialized"}]}],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L64"},"initialIsOpen":false},{"id":"def-common.TemplateListItem","type":"Interface","label":"TemplateListItem","description":["\nInterface for the template list in our UI table\nwe don't include the mappings, settings and aliases\nto reduce the payload size sent back to the client."],"children":[{"id":"def-common.TemplateListItem.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L75"}},{"id":"def-common.TemplateListItem.indexPatterns","type":"Array","label":"indexPatterns","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":76,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L76"},"signature":["string[]"]},{"id":"def-common.TemplateListItem.version","type":"number","label":"version","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L77"},"signature":["number | undefined"]},{"id":"def-common.TemplateListItem.order","type":"number","label":"order","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L78"},"signature":["number | undefined"]},{"id":"def-common.TemplateListItem.priority","type":"number","label":"priority","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":79,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L79"},"signature":["number | undefined"]},{"id":"def-common.TemplateListItem.hasSettings","type":"boolean","label":"hasSettings","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L80"}},{"id":"def-common.TemplateListItem.hasAliases","type":"boolean","label":"hasAliases","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L81"}},{"id":"def-common.TemplateListItem.hasMappings","type":"boolean","label":"hasMappings","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":82,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L82"}},{"id":"def-common.TemplateListItem.ilmPolicy","type":"Object","label":"ilmPolicy","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":83,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L83"},"signature":["{ name: string; } | undefined"]},{"id":"def-common.TemplateListItem._kbnMeta","type":"Object","label":"_kbnMeta","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L86"},"signature":["{ type: ",{"pluginId":"indexManagement","scope":"common","docId":"kibIndexManagementPluginApi","section":"def-common.TemplateType","text":"TemplateType"},"; hasDatastream: boolean; isLegacy?: boolean | undefined; }"]}],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L74"},"initialIsOpen":false},{"id":"def-common.LegacyTemplateSerialized","type":"Interface","label":"LegacyTemplateSerialized","description":["\n------------------------------------------\n--------- LEGACY INDEX TEMPLATES ---------\n------------------------------------------"],"children":[{"id":"def-common.LegacyTemplateSerialized.index_patterns","type":"Array","label":"index_patterns","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":100,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L100"},"signature":["string[]"]},{"id":"def-common.LegacyTemplateSerialized.version","type":"number","label":"version","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L101"},"signature":["number | undefined"]},{"id":"def-common.LegacyTemplateSerialized.settings","type":"Object","label":"settings","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":102,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L102"},"signature":[{"pluginId":"indexManagement","scope":"common","docId":"kibIndexManagementPluginApi","section":"def-common.IndexSettings","text":"IndexSettings"}," | undefined"]},{"id":"def-common.LegacyTemplateSerialized.aliases","type":"Object","label":"aliases","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":103,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L103"},"signature":[{"pluginId":"indexManagement","scope":"common","docId":"kibIndexManagementPluginApi","section":"def-common.Aliases","text":"Aliases"}," | undefined"]},{"id":"def-common.LegacyTemplateSerialized.mappings","type":"Object","label":"mappings","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":104,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L104"},"signature":[{"pluginId":"indexManagement","scope":"common","docId":"kibIndexManagementPluginApi","section":"def-common.Mappings","text":"Mappings"}," | undefined"]},{"id":"def-common.LegacyTemplateSerialized.order","type":"number","label":"order","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":105,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L105"},"signature":["number | undefined"]}],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":99,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L99"},"initialIsOpen":false},{"id":"def-common.ComponentTemplateSerialized","type":"Interface","label":"ComponentTemplateSerialized","description":[],"children":[{"id":"def-common.ComponentTemplateSerialized.template","type":"Object","label":"template","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/component_templates.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L13"},"signature":["{ settings?: ",{"pluginId":"indexManagement","scope":"common","docId":"kibIndexManagementPluginApi","section":"def-common.IndexSettings","text":"IndexSettings"}," | undefined; aliases?: ",{"pluginId":"indexManagement","scope":"common","docId":"kibIndexManagementPluginApi","section":"def-common.Aliases","text":"Aliases"}," | undefined; mappings?: ",{"pluginId":"indexManagement","scope":"common","docId":"kibIndexManagementPluginApi","section":"def-common.Mappings","text":"Mappings"}," | undefined; }"]},{"id":"def-common.ComponentTemplateSerialized.version","type":"number","label":"version","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/component_templates.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L18"},"signature":["number | undefined"]},{"id":"def-common.ComponentTemplateSerialized._meta","type":"Object","label":"_meta","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/component_templates.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L19"},"signature":["{ [key: string]: any; } | undefined"]}],"source":{"path":"x-pack/plugins/index_management/common/types/component_templates.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L12"},"initialIsOpen":false},{"id":"def-common.ComponentTemplateDeserialized","type":"Interface","label":"ComponentTemplateDeserialized","signature":[{"pluginId":"indexManagement","scope":"common","docId":"kibIndexManagementPluginApi","section":"def-common.ComponentTemplateDeserialized","text":"ComponentTemplateDeserialized"}," extends ",{"pluginId":"indexManagement","scope":"common","docId":"kibIndexManagementPluginApi","section":"def-common.ComponentTemplateSerialized","text":"ComponentTemplateSerialized"}],"description":[],"children":[{"id":"def-common.ComponentTemplateDeserialized.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/component_templates.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L23"}},{"id":"def-common.ComponentTemplateDeserialized._kbnMeta","type":"Object","label":"_kbnMeta","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/component_templates.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L24"},"signature":["{ usedBy: string[]; isManaged: boolean; }"]}],"source":{"path":"x-pack/plugins/index_management/common/types/component_templates.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L22"},"initialIsOpen":false},{"id":"def-common.ComponentTemplateFromEs","type":"Interface","label":"ComponentTemplateFromEs","description":[],"children":[{"id":"def-common.ComponentTemplateFromEs.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/component_templates.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L31"}},{"id":"def-common.ComponentTemplateFromEs.component_template","type":"Object","label":"component_template","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/component_templates.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L32"},"signature":[{"pluginId":"indexManagement","scope":"common","docId":"kibIndexManagementPluginApi","section":"def-common.ComponentTemplateSerialized","text":"ComponentTemplateSerialized"}]}],"source":{"path":"x-pack/plugins/index_management/common/types/component_templates.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L30"},"initialIsOpen":false},{"id":"def-common.ComponentTemplateListItem","type":"Interface","label":"ComponentTemplateListItem","description":[],"children":[{"id":"def-common.ComponentTemplateListItem.name","type":"string","label":"name","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/component_templates.ts","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L36"}},{"id":"def-common.ComponentTemplateListItem.usedBy","type":"Array","label":"usedBy","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/component_templates.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L37"},"signature":["string[]"]},{"id":"def-common.ComponentTemplateListItem.hasMappings","type":"boolean","label":"hasMappings","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/component_templates.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L38"}},{"id":"def-common.ComponentTemplateListItem.hasAliases","type":"boolean","label":"hasAliases","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/component_templates.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L39"}},{"id":"def-common.ComponentTemplateListItem.hasSettings","type":"boolean","label":"hasSettings","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/component_templates.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L40"}},{"id":"def-common.ComponentTemplateListItem.isManaged","type":"boolean","label":"isManaged","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/component_templates.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L41"}}],"source":{"path":"x-pack/plugins/index_management/common/types/component_templates.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/component_templates.ts#L35"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-common.API_BASE_PATH","type":"string","label":"API_BASE_PATH","description":[],"source":{"path":"x-pack/plugins/index_management/common/constants/api_base_path.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/constants/api_base_path.ts#L8"},"signature":["\"/api/index_management\""],"initialIsOpen":false},{"id":"def-common.BASE_PATH","type":"string","label":"BASE_PATH","description":[],"source":{"path":"x-pack/plugins/index_management/common/constants/base_path.ts","lineNumber":8,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/constants/base_path.ts#L8"},"signature":["\"/management/data/index_management/\""],"initialIsOpen":false},{"id":"def-common.Health","type":"Type","label":"Health","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/data_streams.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/data_streams.ts#L51"},"signature":["\"green\" | \"yellow\" | \"red\""],"initialIsOpen":false},{"id":"def-common.TemplateType","type":"Type","label":"TemplateType","description":[],"source":{"path":"x-pack/plugins/index_management/common/types/templates.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/index_management/common/types/templates.ts#L62"},"signature":["\"default\" | \"system\" | \"managed\" | \"cloudManaged\""],"initialIsOpen":false}],"objects":[]}} \ No newline at end of file diff --git a/api_docs/index_management.mdx b/api_docs/index_management.mdx new file mode 100644 index 0000000000000..24d63f91612e2 --- /dev/null +++ b/api_docs/index_management.mdx @@ -0,0 +1,34 @@ +--- +id: kibIndexManagementPluginApi +slug: /kibana-dev-docs/indexManagementPluginApi +title: indexManagement +image: https://source.unsplash.com/400x175/?github +summary: API docs for the indexManagement plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexManagement'] +--- + +import indexManagementObj from './index_management.json'; + +## Client + +### Functions + +### Interfaces + +## Server + +### Setup + +### Interfaces + +### Consts, variables and types + +## Common + +### Functions + +### Interfaces + +### Consts, variables and types + diff --git a/api_docs/index_pattern_field_editor.json b/api_docs/index_pattern_field_editor.json new file mode 100644 index 0000000000000..1d1eae4be1c36 --- /dev/null +++ b/api_docs/index_pattern_field_editor.json @@ -0,0 +1 @@ +{"id":"indexPatternFieldEditor","client":{"classes":[{"id":"def-public.DefaultFormatEditor","type":"Class","label":"DefaultFormatEditor","description":[],"signature":[{"pluginId":"indexPatternFieldEditor","scope":"public","docId":"kibIndexPatternFieldEditorPluginApi","section":"def-public.DefaultFormatEditor","text":"DefaultFormatEditor"}," extends React.PureComponent<","FormatEditorProps","

, ","FormatEditorState"," & S, any>"],"children":[{"id":"def-public.DefaultFormatEditor.formatId","type":"string","label":"formatId","description":[],"source":{"path":"src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L77"}},{"id":"def-public.DefaultFormatEditor.state","type":"CompoundType","label":"state","description":[],"source":{"path":"src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx","lineNumber":78,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L78"},"signature":[{"pluginId":"indexPatternFieldEditor","scope":"public","docId":"kibIndexPatternFieldEditorPluginApi","section":"def-public.FormatEditorState","text":"FormatEditorState"}," & S"]},{"id":"def-public.DefaultFormatEditor.getDerivedStateFromProps","type":"Function","label":"getDerivedStateFromProps","signature":["typeof ",{"pluginId":"indexPatternFieldEditor","scope":"public","docId":"kibIndexPatternFieldEditorPluginApi","section":"def-public.DefaultFormatEditor","text":"DefaultFormatEditor"},".getDerivedStateFromProps"],"description":[],"children":[{"type":"Object","label":"nextProps","isRequired":true,"signature":[{"pluginId":"indexPatternFieldEditor","scope":"public","docId":"kibIndexPatternFieldEditorPluginApi","section":"def-public.FormatEditorProps","text":"FormatEditorProps"},"<{}>"],"description":[],"source":{"path":"src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L80"}},{"type":"Object","label":"state","isRequired":true,"signature":[{"pluginId":"indexPatternFieldEditor","scope":"public","docId":"kibIndexPatternFieldEditorPluginApi","section":"def-public.FormatEditorState","text":"FormatEditorState"}],"description":[],"source":{"path":"src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L80"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx","lineNumber":80,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L80"}},{"id":"def-public.DefaultFormatEditor.onChange","type":"Function","children":[{"type":"Object","label":"newParams","isRequired":true,"signature":["{}"],"description":[],"source":{"path":"src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L92"}}],"signature":["(newParams?: {}) => void"],"description":[],"label":"onChange","source":{"path":"src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx","lineNumber":92,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L92"},"returnComment":[]},{"id":"def-public.DefaultFormatEditor.render","type":"Function","label":"render","signature":["() => JSX.Element"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L101"}}],"source":{"path":"src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L73"},"initialIsOpen":false}],"functions":[],"interfaces":[{"id":"def-public.OpenFieldEditorOptions","type":"Interface","label":"OpenFieldEditorOptions","description":[],"children":[{"id":"def-public.OpenFieldEditorOptions.ctx","type":"Object","label":"ctx","description":[],"source":{"path":"src/plugins/index_pattern_field_editor/public/open_editor.tsx","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/open_editor.tsx#L28"},"signature":["{ indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"},"; }"]},{"id":"def-public.OpenFieldEditorOptions.onSave","type":"Function","label":"onSave","description":[],"source":{"path":"src/plugins/index_pattern_field_editor/public/open_editor.tsx","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/open_editor.tsx#L31"},"signature":["((field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPatternField","text":"IndexPatternField"},") => void) | undefined"]},{"id":"def-public.OpenFieldEditorOptions.fieldName","type":"string","label":"fieldName","description":[],"source":{"path":"src/plugins/index_pattern_field_editor/public/open_editor.tsx","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/open_editor.tsx#L32"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/index_pattern_field_editor/public/open_editor.tsx","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/open_editor.tsx#L27"},"initialIsOpen":false},{"id":"def-public.FieldEditorContext","type":"Interface","label":"FieldEditorContext","description":[],"children":[{"id":"def-public.FieldEditorContext.indexPattern","type":"Object","label":"indexPattern","description":[],"source":{"path":"src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx#L28"},"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IndexPattern","text":"IndexPattern"}]},{"id":"def-public.FieldEditorContext.fieldTypeToProcess","type":"CompoundType","label":"fieldTypeToProcess","description":["\nThe Kibana field type of the field to create or edit\nDefault: \"runtime\""],"source":{"path":"src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx#L33"},"signature":[{"pluginId":"indexPatternFieldEditor","scope":"public","docId":"kibIndexPatternFieldEditorPluginApi","section":"def-public.InternalFieldType","text":"InternalFieldType"}]},{"id":"def-public.FieldEditorContext.search","type":"Object","label":"search","description":["The search service from the data plugin"],"source":{"path":"src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx#L35"},"signature":[{"pluginId":"data","scope":"public","docId":"kibDataSearchPluginApi","section":"def-public.ISearchStart","text":"ISearchStart"}]}],"source":{"path":"src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx#L27"},"initialIsOpen":false}],"enums":[],"misc":[],"objects":[],"start":{"id":"def-public.PluginStart","type":"Interface","label":"PluginStart","description":[],"children":[{"id":"def-public.PluginStart.openEditor","type":"Function","label":"openEditor","signature":["(options: ",{"pluginId":"indexPatternFieldEditor","scope":"public","docId":"kibIndexPatternFieldEditorPluginApi","section":"def-public.OpenFieldEditorOptions","text":"OpenFieldEditorOptions"},") => () => void"],"description":[],"children":[{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"indexPatternFieldEditor","scope":"public","docId":"kibIndexPatternFieldEditorPluginApi","section":"def-public.OpenFieldEditorOptions","text":"OpenFieldEditorOptions"}],"description":[],"source":{"path":"src/plugins/index_pattern_field_editor/public/types.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/types.ts#L26"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/index_pattern_field_editor/public/types.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/types.ts#L26"}},{"id":"def-public.PluginStart.fieldFormatEditors","type":"Object","label":"fieldFormatEditors","description":[],"source":{"path":"src/plugins/index_pattern_field_editor/public/types.ts","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/types.ts#L27"},"signature":["{ getAll: () => typeof ",{"pluginId":"indexPatternFieldEditor","scope":"public","docId":"kibIndexPatternFieldEditorPluginApi","section":"def-public.DefaultFormatEditor","text":"DefaultFormatEditor"},"[]; getById: (id: string) => typeof ",{"pluginId":"indexPatternFieldEditor","scope":"public","docId":"kibIndexPatternFieldEditorPluginApi","section":"def-public.DefaultFormatEditor","text":"DefaultFormatEditor"}," | undefined; }"]},{"id":"def-public.PluginStart.userPermissions","type":"Object","label":"userPermissions","description":[],"source":{"path":"src/plugins/index_pattern_field_editor/public/types.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/types.ts#L28"},"signature":["{ editIndexPattern: () => boolean; }"]},{"id":"def-public.PluginStart.DeleteRuntimeFieldProvider","type":"Function","label":"DeleteRuntimeFieldProvider","description":[],"source":{"path":"src/plugins/index_pattern_field_editor/public/types.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/types.ts#L31"},"signature":["React.FunctionComponent<",{"pluginId":"indexPatternFieldEditor","scope":"public","docId":"kibIndexPatternFieldEditorPluginApi","section":"def-public.Props","text":"Props"},">"]}],"source":{"path":"src/plugins/index_pattern_field_editor/public/types.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_field_editor/public/types.ts#L25"},"lifecycle":"start","initialIsOpen":true}},"server":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]}} \ No newline at end of file diff --git a/api_docs/index_pattern_field_editor.mdx b/api_docs/index_pattern_field_editor.mdx new file mode 100644 index 0000000000000..b8eb59ee93837 --- /dev/null +++ b/api_docs/index_pattern_field_editor.mdx @@ -0,0 +1,20 @@ +--- +id: kibIndexPatternFieldEditorPluginApi +slug: /kibana-dev-docs/indexPatternFieldEditorPluginApi +title: indexPatternFieldEditor +image: https://source.unsplash.com/400x175/?github +summary: API docs for the indexPatternFieldEditor plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexPatternFieldEditor'] +--- + +import indexPatternFieldEditorObj from './index_pattern_field_editor.json'; + +## Client + +### Start + +### Classes + +### Interfaces + diff --git a/api_docs/index_pattern_management.json b/api_docs/index_pattern_management.json new file mode 100644 index 0000000000000..dbf01b915f662 --- /dev/null +++ b/api_docs/index_pattern_management.json @@ -0,0 +1 @@ +{"id":"indexPatternManagement","client":{"classes":[{"id":"def-public.IndexPatternCreationConfig","type":"Class","label":"IndexPatternCreationConfig","description":[],"children":[{"id":"def-public.IndexPatternCreationConfig.key","type":"string","label":"key","description":[],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L38"},"signature":["\"default\""]},{"id":"def-public.IndexPatternCreationConfig.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L40"},"signature":["string | undefined"]},{"id":"def-public.IndexPatternCreationConfig.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L41"}},{"id":"def-public.IndexPatternCreationConfig.showSystemIndices","type":"boolean","label":"showSystemIndices","description":[],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L42"}},{"id":"def-public.IndexPatternCreationConfig.httpClient","type":"CompoundType","label":"httpClient","description":[],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L43"},"signature":["object | null"]},{"id":"def-public.IndexPatternCreationConfig.isBeta","type":"boolean","label":"isBeta","description":[],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L44"}},{"id":"def-public.IndexPatternCreationConfig.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"id":"def-public.IndexPatternCreationConfig.Unnamed.{\n- type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }","type":"Object","label":"{\n type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }","description":[],"children":[{"id":"def-public.IndexPatternCreationConfig.Unnamed.{\n- type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L53"},"signature":["string | undefined"]},{"id":"def-public.IndexPatternCreationConfig.Unnamed.{\n- type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }.name","type":"string","label":"name","description":[],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L54"},"signature":["string | undefined"]},{"id":"def-public.IndexPatternCreationConfig.Unnamed.{\n- type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }.showSystemIndices","type":"CompoundType","label":"showSystemIndices","description":[],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L55"},"signature":["boolean | undefined"]},{"id":"def-public.IndexPatternCreationConfig.Unnamed.{\n- type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }.httpClient","type":"CompoundType","label":"httpClient","description":[],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":56,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L56"},"signature":["object | null | undefined"]},{"id":"def-public.IndexPatternCreationConfig.Unnamed.{\n- type = undefined,\n name = indexPatternTypeName,\n showSystemIndices = true,\n httpClient = null,\n isBeta = false,\n }.isBeta","type":"CompoundType","label":"isBeta","description":[],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L57"},"signature":["boolean | undefined"]}],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L52"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L46"}},{"id":"def-public.IndexPatternCreationConfig.getIndexPatternCreationOption","type":"Function","label":"getIndexPatternCreationOption","signature":["(urlHandler: ",{"pluginId":"indexPatternManagement","scope":"public","docId":"kibIndexPatternManagementPluginApi","section":"def-public.UrlHandler","text":"UrlHandler"},") => ",{"pluginId":"indexPatternManagement","scope":"public","docId":"kibIndexPatternManagementPluginApi","section":"def-public.IndexPatternCreationOption","text":"IndexPatternCreationOption"}],"description":[],"children":[{"type":"Function","label":"urlHandler","isRequired":true,"signature":[{"pluginId":"indexPatternManagement","scope":"public","docId":"kibIndexPatternManagementPluginApi","section":"def-public.UrlHandler","text":"UrlHandler"}],"description":[],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L66"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L66"}},{"id":"def-public.IndexPatternCreationConfig.getIndexPatternType","type":"Function","label":"getIndexPatternType","signature":["() => string | undefined"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":77,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L77"}},{"id":"def-public.IndexPatternCreationConfig.getIndexPatternName","type":"Function","label":"getIndexPatternName","signature":["() => string"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":81,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L81"}},{"id":"def-public.IndexPatternCreationConfig.getIsBeta","type":"Function","label":"getIsBeta","signature":["() => boolean"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":85,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L85"}},{"id":"def-public.IndexPatternCreationConfig.getShowSystemIndices","type":"Function","label":"getShowSystemIndices","signature":["() => boolean"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":89,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L89"}},{"id":"def-public.IndexPatternCreationConfig.getIndexTags","type":"Function","label":"getIndexTags","signature":["(indexName: string) => never[]"],"description":[],"children":[{"type":"string","label":"indexName","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":93,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L93"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":93,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L93"}},{"id":"def-public.IndexPatternCreationConfig.checkIndicesForErrors","type":"Function","label":"checkIndicesForErrors","signature":["(indices: ",{"pluginId":"indexPatternManagement","scope":"public","docId":"kibIndexPatternManagementPluginApi","section":"def-public.MatchedItem","text":"MatchedItem"},"[]) => undefined"],"description":[],"children":[{"type":"Array","label":"indices","isRequired":true,"signature":[{"pluginId":"indexPatternManagement","scope":"public","docId":"kibIndexPatternManagementPluginApi","section":"def-public.MatchedItem","text":"MatchedItem"},"[]"],"description":[],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L97"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":97,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L97"}},{"id":"def-public.IndexPatternCreationConfig.getIndexPatternMappings","type":"Function","label":"getIndexPatternMappings","signature":["() => {}"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":101,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L101"}},{"id":"def-public.IndexPatternCreationConfig.renderPrompt","type":"Function","label":"renderPrompt","signature":["() => null"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":105,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L105"}},{"id":"def-public.IndexPatternCreationConfig.getFetchForWildcardOptions","type":"Function","label":"getFetchForWildcardOptions","signature":["() => {}"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":109,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L109"}}],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L37"},"initialIsOpen":false},{"id":"def-public.IndexPatternListConfig","type":"Class","label":"IndexPatternListConfig","description":[],"children":[{"id":"def-public.IndexPatternListConfig.key","type":"string","label":"key","description":[],"source":{"path":"src/plugins/index_pattern_management/public/service/list/config.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L26"},"signature":["\"default\""]},{"id":"def-public.IndexPatternListConfig.getIndexPatternTags","type":"Function","label":"getIndexPatternTags","signature":["(indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"}," | ",{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SimpleSavedObject","text":"SimpleSavedObject"},"<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"},">, isDefault: boolean) => ",{"pluginId":"indexPatternManagement","scope":"public","docId":"kibIndexPatternManagementPluginApi","section":"def-public.IndexPatternTag","text":"IndexPatternTag"},"[]"],"description":[],"children":[{"type":"CompoundType","label":"indexPattern","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"}," | ",{"pluginId":"core","scope":"public","docId":"kibCoreSavedObjectsPluginApi","section":"def-public.SimpleSavedObject","text":"SimpleSavedObject"},"<",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"},">"],"description":[],"source":{"path":"src/plugins/index_pattern_management/public/service/list/config.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L29"}},{"type":"boolean","label":"isDefault","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/index_pattern_management/public/service/list/config.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L30"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/index_pattern_management/public/service/list/config.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L28"}},{"id":"def-public.IndexPatternListConfig.getFieldInfo","type":"Function","label":"getFieldInfo","signature":["(indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"},", field: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"},") => string[]"],"description":[],"children":[{"type":"Object","label":"indexPattern","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"}],"description":[],"source":{"path":"src/plugins/index_pattern_management/public/service/list/config.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L42"}},{"type":"Object","label":"field","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IFieldType","text":"IFieldType"}],"description":[],"source":{"path":"src/plugins/index_pattern_management/public/service/list/config.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L42"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/index_pattern_management/public/service/list/config.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L42"}},{"id":"def-public.IndexPatternListConfig.areScriptedFieldsEnabled","type":"Function","label":"areScriptedFieldsEnabled","signature":["(indexPattern: ",{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"},") => boolean"],"description":[],"children":[{"type":"Object","label":"indexPattern","isRequired":true,"signature":[{"pluginId":"data","scope":"common","docId":"kibDataIndexPatternsPluginApi","section":"def-common.IIndexPattern","text":"IIndexPattern"}],"description":[],"source":{"path":"src/plugins/index_pattern_management/public/service/list/config.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L46"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/index_pattern_management/public/service/list/config.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L46"}}],"source":{"path":"src/plugins/index_pattern_management/public/service/list/config.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/list/config.ts#L25"},"initialIsOpen":false}],"functions":[],"interfaces":[{"id":"def-public.IndexPatternCreationOption","type":"Interface","label":"IndexPatternCreationOption","description":[],"children":[{"id":"def-public.IndexPatternCreationOption.text","type":"string","label":"text","description":[],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L30"}},{"id":"def-public.IndexPatternCreationOption.description","type":"string","label":"description","description":[],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L31"}},{"id":"def-public.IndexPatternCreationOption.testSubj","type":"string","label":"testSubj","description":[],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L32"}},{"id":"def-public.IndexPatternCreationOption.onClick","type":"Function","label":"onClick","description":[],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L33"},"signature":["() => void"]},{"id":"def-public.IndexPatternCreationOption.isBeta","type":"CompoundType","label":"isBeta","description":[],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L34"},"signature":["boolean | undefined"]}],"source":{"path":"src/plugins/index_pattern_management/public/service/creation/config.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/service/creation/config.ts#L29"},"initialIsOpen":false}],"enums":[{"id":"def-public.MlCardState","type":"Enum","label":"MlCardState","description":[],"source":{"path":"src/plugins/index_pattern_management/public/types.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/types.ts#L42"},"initialIsOpen":false}],"misc":[],"objects":[],"setup":{"id":"def-public.IndexPatternManagementSetup","type":"Type","label":"IndexPatternManagementSetup","description":[],"source":{"path":"src/plugins/index_pattern_management/public/plugin.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/plugin.ts#L32"},"signature":["{ creation: { addCreationConfig: (Config: typeof ",{"pluginId":"indexPatternManagement","scope":"public","docId":"kibIndexPatternManagementPluginApi","section":"def-public.IndexPatternCreationConfig","text":"IndexPatternCreationConfig"},") => void; }; list: { addListConfig: (Config: typeof ",{"pluginId":"indexPatternManagement","scope":"public","docId":"kibIndexPatternManagementPluginApi","section":"def-public.IndexPatternListConfig","text":"IndexPatternListConfig"},") => void; }; environment: { update: (update: Partial<","Environment",">) => void; }; }"],"lifecycle":"setup","initialIsOpen":true},"start":{"id":"def-public.IndexPatternManagementStart","type":"Type","label":"IndexPatternManagementStart","description":[],"source":{"path":"src/plugins/index_pattern_management/public/plugin.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/index_pattern_management/public/plugin.ts#L34"},"signature":["{ creation: { getType: (key: string | undefined) => ",{"pluginId":"indexPatternManagement","scope":"public","docId":"kibIndexPatternManagementPluginApi","section":"def-public.IndexPatternCreationConfig","text":"IndexPatternCreationConfig"},"; getIndexPatternCreationOptions: (urlHandler: ","UrlHandler",") => Promise<",{"pluginId":"indexPatternManagement","scope":"public","docId":"kibIndexPatternManagementPluginApi","section":"def-public.IndexPatternCreationOption","text":"IndexPatternCreationOption"},"[]>; }; list: { getIndexPatternTags: (indexPattern: ",{"pluginId":"data","scope":"public","docId":"kibDataPluginApi","section":"def-public.IIndexPattern","text":"IIndexPattern"}," | ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.SimpleSavedObject","text":"SimpleSavedObject"}],"lifecycle":"start","initialIsOpen":true}},"server":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]}} \ No newline at end of file diff --git a/api_docs/index_pattern_management.mdx b/api_docs/index_pattern_management.mdx new file mode 100644 index 0000000000000..702a53458158c --- /dev/null +++ b/api_docs/index_pattern_management.mdx @@ -0,0 +1,24 @@ +--- +id: kibIndexPatternManagementPluginApi +slug: /kibana-dev-docs/indexPatternManagementPluginApi +title: indexPatternManagement +image: https://source.unsplash.com/400x175/?github +summary: API docs for the indexPatternManagement plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'indexPatternManagement'] +--- + +import indexPatternManagementObj from './index_pattern_management.json'; + +## Client + +### Setup + +### Start + +### Classes + +### Interfaces + +### Enums + diff --git a/api_docs/infra.json b/api_docs/infra.json new file mode 100644 index 0000000000000..3668973e15ea2 --- /dev/null +++ b/api_docs/infra.json @@ -0,0 +1 @@ +{"id":"infra","client":{"classes":[],"functions":[{"id":"def-public.LazyLogStreamWrapper","type":"Function","children":[{"type":"CompoundType","label":"props","isRequired":true,"signature":["React.PropsWithChildren<",{"pluginId":"infra","scope":"public","docId":"kibInfraPluginApi","section":"def-public.LogStreamProps","text":"LogStreamProps"},">"],"description":[],"source":{"path":"x-pack/plugins/infra/public/components/log_stream/lazy_log_stream_wrapper.tsx","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/public/components/log_stream/lazy_log_stream_wrapper.tsx#L13"}}],"signature":["(props: React.PropsWithChildren<","LogStreamProps",">) => JSX.Element"],"description":[],"label":"LazyLogStreamWrapper","source":{"path":"x-pack/plugins/infra/public/components/log_stream/lazy_log_stream_wrapper.tsx","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/public/components/log_stream/lazy_log_stream_wrapper.tsx#L13"},"returnComment":[],"initialIsOpen":false}],"interfaces":[],"enums":[{"id":"def-public.InfraFormatterType","type":"Enum","label":"InfraFormatterType","description":[],"source":{"path":"x-pack/plugins/infra/public/lib/lib.ts","lineNumber":147,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/public/lib/lib.ts#L147"},"initialIsOpen":false}],"misc":[{"id":"def-public.InfraAppId","type":"Type","label":"InfraAppId","description":[],"source":{"path":"x-pack/plugins/infra/public/index.ts","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/public/index.ts#L29"},"signature":["\"metrics\" | \"logs\""],"initialIsOpen":false}],"objects":[{"id":"def-public.FORMATTERS","type":"Object","children":[{"id":"def-public.FORMATTERS.number","type":"Function","label":"number","description":[],"source":{"path":"x-pack/plugins/infra/common/formatters/index.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/common/formatters/index.ts#L16"},"signature":["(val: number) => string"]},{"id":"def-public.FORMATTERS.abbreviatedNumber","type":"Function","label":"abbreviatedNumber","description":["// Because the implimentation for formatting large numbers is the same as formatting\n// bytes we are re-using the same code, we just format the number using the abbreviated number format."],"source":{"path":"x-pack/plugins/infra/common/formatters/index.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/common/formatters/index.ts#L19"},"signature":["(bytes: number) => string"]},{"id":"def-public.FORMATTERS.bytes","type":"Function","label":"bytes","description":["// bytes in bytes formatted string out"],"source":{"path":"x-pack/plugins/infra/common/formatters/index.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/common/formatters/index.ts#L21"},"signature":["(bytes: number) => string"]},{"id":"def-public.FORMATTERS.bits","type":"Function","label":"bits","description":["// bytes in bits formatted string out"],"source":{"path":"x-pack/plugins/infra/common/formatters/index.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/common/formatters/index.ts#L23"},"signature":["(bytes: number) => string"]},{"id":"def-public.FORMATTERS.percent","type":"Function","label":"percent","description":[],"source":{"path":"x-pack/plugins/infra/common/formatters/index.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/common/formatters/index.ts#L24"},"signature":["(val: number) => string"]},{"id":"def-public.FORMATTERS.highPercision","type":"Function","label":"highPercision","description":[],"source":{"path":"x-pack/plugins/infra/common/formatters/index.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/common/formatters/index.ts#L25"},"signature":["(val: number) => string"]}],"description":[],"label":"FORMATTERS","source":{"path":"x-pack/plugins/infra/common/formatters/index.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/common/formatters/index.ts#L15"},"initialIsOpen":false}]},"server":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[{"id":"def-server.InfraConfig","type":"Type","label":"InfraConfig","description":[],"source":{"path":"x-pack/plugins/infra/server/plugin.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/server/plugin.ts#L64"},"signature":["{ readonly sources?: Readonly<{ default?: Readonly<{ fields?: Readonly<{ host?: string | undefined; message?: string[] | undefined; timestamp?: string | undefined; tiebreaker?: string | undefined; container?: string | undefined; pod?: string | undefined; } & {}> | undefined; logAlias?: string | undefined; metricAlias?: string | undefined; } & {}> | undefined; } & {}> | undefined; readonly enabled: boolean; readonly query: Readonly<{} & { partitionSize: number; partitionFactor: number; }>; }"],"initialIsOpen":false}],"objects":[],"setup":{"id":"def-server.InfraPluginSetup","type":"Interface","label":"InfraPluginSetup","description":[],"children":[{"id":"def-server.InfraPluginSetup.defineInternalSourceConfiguration","type":"Function","label":"defineInternalSourceConfiguration","description":[],"source":{"path":"x-pack/plugins/infra/server/plugin.ts","lineNumber":75,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/server/plugin.ts#L75"},"signature":["(sourceId: string, sourceProperties: ",{"pluginId":"infra","scope":"common","docId":"kibInfraPluginApi","section":"def-common.InfraStaticSourceConfiguration","text":"InfraStaticSourceConfiguration"},") => void"]}],"source":{"path":"x-pack/plugins/infra/server/plugin.ts","lineNumber":74,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/infra/server/plugin.ts#L74"},"lifecycle":"setup","initialIsOpen":true}},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]}} \ No newline at end of file diff --git a/api_docs/infra.mdx b/api_docs/infra.mdx new file mode 100644 index 0000000000000..66bbf62b812bf --- /dev/null +++ b/api_docs/infra.mdx @@ -0,0 +1,28 @@ +--- +id: kibInfraPluginApi +slug: /kibana-dev-docs/infraPluginApi +title: infra +image: https://source.unsplash.com/400x175/?github +summary: API docs for the infra plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'infra'] +--- + +import infraObj from './infra.json'; + +## Client + +### Objects + +### Functions + +### Enums + +### Consts, variables and types + +## Server + +### Setup + +### Consts, variables and types + diff --git a/api_docs/ingest_pipelines.json b/api_docs/ingest_pipelines.json new file mode 100644 index 0000000000000..d364285e0db78 --- /dev/null +++ b/api_docs/ingest_pipelines.json @@ -0,0 +1 @@ +{"id":"ingestPipelines","client":{"classes":[{"id":"def-public.IngestPipelinesUrlGenerator","type":"Class","label":"IngestPipelinesUrlGenerator","description":[],"signature":[{"pluginId":"ingestPipelines","scope":"public","docId":"kibIngestPipelinesPluginApi","section":"def-public.IngestPipelinesUrlGenerator","text":"IngestPipelinesUrlGenerator"}," implements ",{"pluginId":"share","scope":"public","docId":"kibSharePluginApi","section":"def-public.UrlGeneratorsDefinition","text":"UrlGeneratorsDefinition"},"<\"INGEST_PIPELINES_APP_URL_GENERATOR\">"],"children":[{"id":"def-public.IngestPipelinesUrlGenerator.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Function","label":"getAppBasePath","isRequired":true,"signature":["(absolute: boolean) => Promise"],"description":[],"source":{"path":"x-pack/plugins/ingest_pipelines/public/url_generator.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/ingest_pipelines/public/url_generator.ts#L57"}}],"tags":[],"returnComment":[],"source":{"path":"x-pack/plugins/ingest_pipelines/public/url_generator.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/ingest_pipelines/public/url_generator.ts#L57"}},{"id":"def-public.IngestPipelinesUrlGenerator.id","type":"string","label":"id","description":[],"source":{"path":"x-pack/plugins/ingest_pipelines/public/url_generator.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/ingest_pipelines/public/url_generator.ts#L59"},"signature":["\"INGEST_PIPELINES_APP_URL_GENERATOR\""]},{"id":"def-public.IngestPipelinesUrlGenerator.createUrl","type":"Function","children":[{"type":"CompoundType","label":"state","isRequired":true,"signature":[{"pluginId":"ingestPipelines","scope":"public","docId":"kibIngestPipelinesPluginApi","section":"def-public.IngestPipelinesUrlGeneratorState","text":"IngestPipelinesUrlGeneratorState"}],"description":[],"source":{"path":"x-pack/plugins/ingest_pipelines/public/url_generator.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/ingest_pipelines/public/url_generator.ts#L61"}}],"signature":["(state: ",{"pluginId":"ingestPipelines","scope":"public","docId":"kibIngestPipelinesPluginApi","section":"def-public.IngestPipelinesUrlGeneratorState","text":"IngestPipelinesUrlGeneratorState"},") => Promise"],"description":[],"label":"createUrl","source":{"path":"x-pack/plugins/ingest_pipelines/public/url_generator.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/ingest_pipelines/public/url_generator.ts#L61"},"returnComment":[]}],"source":{"path":"x-pack/plugins/ingest_pipelines/public/url_generator.ts","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/ingest_pipelines/public/url_generator.ts#L55"},"initialIsOpen":false}],"functions":[],"interfaces":[],"enums":[{"id":"def-public.INGEST_PIPELINES_PAGES","type":"Enum","label":"INGEST_PIPELINES_PAGES","description":[],"source":{"path":"x-pack/plugins/ingest_pipelines/public/url_generator.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/ingest_pipelines/public/url_generator.ts#L22"},"initialIsOpen":false}],"misc":[{"id":"def-public.INGEST_PIPELINES_APP_ULR_GENERATOR","type":"string","label":"INGEST_PIPELINES_APP_ULR_GENERATOR","description":[],"source":{"path":"x-pack/plugins/ingest_pipelines/public/url_generator.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/ingest_pipelines/public/url_generator.ts#L20"},"signature":["\"INGEST_PIPELINES_APP_URL_GENERATOR\""],"initialIsOpen":false},{"id":"def-public.IngestPipelinesUrlGeneratorState","type":"Type","label":"IngestPipelinesUrlGeneratorState","description":[],"source":{"path":"x-pack/plugins/ingest_pipelines/public/url_generator.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/masterx-pack/plugins/ingest_pipelines/public/url_generator.ts#L49"},"signature":["PipelinesListUrlGeneratorState"," | ","PipelineEditUrlGeneratorState"," | ","PipelineCloneUrlGeneratorState"," | ","PipelineCreateUrlGeneratorState"],"initialIsOpen":false}],"objects":[]},"server":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]}} \ No newline at end of file diff --git a/api_docs/ingest_pipelines.mdx b/api_docs/ingest_pipelines.mdx new file mode 100644 index 0000000000000..0e4ad371e271a --- /dev/null +++ b/api_docs/ingest_pipelines.mdx @@ -0,0 +1,20 @@ +--- +id: kibIngestPipelinesPluginApi +slug: /kibana-dev-docs/ingestPipelinesPluginApi +title: ingestPipelines +image: https://source.unsplash.com/400x175/?github +summary: API docs for the ingestPipelines plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'ingestPipelines'] +--- + +import ingestPipelinesObj from './ingest_pipelines.json'; + +## Client + +### Classes + +### Enums + +### Consts, variables and types + diff --git a/api_docs/inspector.json b/api_docs/inspector.json new file mode 100644 index 0000000000000..3791f229a5a98 --- /dev/null +++ b/api_docs/inspector.json @@ -0,0 +1 @@ +{"id":"inspector","client":{"classes":[{"id":"def-public.InspectorPublicPlugin","type":"Class","label":"InspectorPublicPlugin","description":[],"signature":[{"pluginId":"inspector","scope":"public","docId":"kibInspectorPluginApi","section":"def-public.InspectorPublicPlugin","text":"InspectorPublicPlugin"}," implements ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Plugin","text":"Plugin"},"<",{"pluginId":"inspector","scope":"public","docId":"kibInspectorPluginApi","section":"def-public.Setup","text":"Setup"},", ",{"pluginId":"inspector","scope":"public","docId":"kibInspectorPluginApi","section":"def-public.Start","text":"Start"},", object, object>"],"children":[{"id":"def-public.InspectorPublicPlugin.views","type":"Object","label":"views","description":[],"source":{"path":"src/plugins/inspector/public/plugin.tsx","lineNumber":55,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L55"},"signature":[{"pluginId":"inspector","scope":"public","docId":"kibInspectorPluginApi","section":"def-public.InspectorViewRegistry","text":"InspectorViewRegistry"}," | undefined"]},{"id":"def-public.InspectorPublicPlugin.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"initializerContext","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.PluginInitializerContext","text":"PluginInitializerContext"},""],"description":[],"source":{"path":"src/plugins/inspector/public/plugin.tsx","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L57"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/inspector/public/plugin.tsx","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L57"}},{"id":"def-public.InspectorPublicPlugin.setup","type":"Function","label":"setup","signature":["(core: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreSetup","text":"CoreSetup"},") => { registerView: (view: ",{"pluginId":"inspector","scope":"public","docId":"kibInspectorPluginApi","section":"def-public.InspectorViewDescription","text":"InspectorViewDescription"},") => void; __LEGACY: { views: ",{"pluginId":"inspector","scope":"public","docId":"kibInspectorPluginApi","section":"def-public.InspectorViewRegistry","text":"InspectorViewRegistry"},"; }; }"],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreSetup","text":"CoreSetup"},""],"description":[],"source":{"path":"src/plugins/inspector/public/plugin.tsx","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L59"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/inspector/public/plugin.tsx","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L59"}},{"id":"def-public.InspectorPublicPlugin.start","type":"Function","label":"start","signature":["(core: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreStart","text":"CoreStart"},") => { isAvailable: (adapters?: ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"}," | undefined) => boolean; open: (adapters: ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", options?: ",{"pluginId":"inspector","scope":"public","docId":"kibInspectorPluginApi","section":"def-public.InspectorOptions","text":"InspectorOptions"}," | undefined) => ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.OverlayRef","text":"OverlayRef"}],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreStart","text":"CoreStart"}],"description":[],"source":{"path":"src/plugins/inspector/public/plugin.tsx","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L73"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/inspector/public/plugin.tsx","lineNumber":73,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L73"}},{"id":"def-public.InspectorPublicPlugin.stop","type":"Function","label":"stop","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/inspector/public/plugin.tsx","lineNumber":114,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L114"}}],"source":{"path":"src/plugins/inspector/public/plugin.tsx","lineNumber":54,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L54"},"initialIsOpen":false},{"id":"def-public.RequestAdapter","type":"Class","label":"RequestAdapter","description":["\nAn generic inspector adapter to log requests.\nThese can be presented in the inspector using the requests view.\nThe adapter is not coupled to a specific implementation or even Elasticsearch\ninstead it offers a generic API to log requests of any kind."],"signature":[{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.RequestAdapter","text":"RequestAdapter"}," extends ","EventEmitter"],"children":[{"id":"def-public.RequestAdapter.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_adapter.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L24"}},{"id":"def-public.RequestAdapter.start","type":"Function","label":"start","signature":["(name: string, params?: ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.RequestParams","text":"RequestParams"},") => ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.RequestResponder","text":"RequestResponder"}],"description":["\nStart logging a new request into this request adapter. The new request will\nby default be in a processing state unless you explicitly finish it via\n{@link RequestResponder#finish}, {@link RequestResponder#ok} or\n{@link RequestResponder#error}.\n"],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":["The name of this request as it should be shown in the UI."],"source":{"path":"src/plugins/inspector/common/adapters/request/request_adapter.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L39"}},{"type":"Object","label":"params","isRequired":true,"signature":[{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.RequestParams","text":"RequestParams"}],"description":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_adapter.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L39"}}],"tags":["return"],"returnComment":["An instance to add information to the request and finish it."],"source":{"path":"src/plugins/inspector/common/adapters/request/request_adapter.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L39"}},{"id":"def-public.RequestAdapter.reset","type":"Function","label":"reset","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_adapter.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L52"}},{"id":"def-public.RequestAdapter.resetRequest","type":"Function","label":"resetRequest","signature":["(id: string) => void"],"description":[],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_adapter.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L57"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_adapter.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L57"}},{"id":"def-public.RequestAdapter.getRequests","type":"Function","label":"getRequests","signature":["() => ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Request","text":"Request"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_adapter.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L62"}}],"source":{"path":"src/plugins/inspector/common/adapters/request/request_adapter.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L21"},"initialIsOpen":false},{"id":"def-public.RequestResponder","type":"Class","label":"RequestResponder","description":["\nAn API to specify information about a specific request that will be logged.\nCreate a new instance to log a request using {@link RequestAdapter#start}."],"children":[{"id":"def-public.RequestResponder.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"request","isRequired":true,"signature":[{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Request","text":"Request"}],"description":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_responder.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L20"}},{"type":"Function","label":"onChange","isRequired":true,"signature":["() => void"],"description":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_responder.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L20"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_responder.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L20"}},{"id":"def-public.RequestResponder.json","type":"Function","label":"json","signature":["(reqJson: object) => ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.RequestResponder","text":"RequestResponder"}],"description":[],"children":[{"type":"Uncategorized","label":"reqJson","isRequired":true,"signature":["object"],"description":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_responder.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L25"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_responder.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L25"}},{"id":"def-public.RequestResponder.stats","type":"Function","label":"stats","signature":["(stats: ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.RequestStatistics","text":"RequestStatistics"},") => ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.RequestResponder","text":"RequestResponder"}],"description":[],"children":[{"type":"Object","label":"stats","isRequired":true,"signature":[{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.RequestStatistics","text":"RequestStatistics"}],"description":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_responder.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L31"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_responder.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L31"}},{"id":"def-public.RequestResponder.finish","type":"Function","label":"finish","signature":["(status: ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.RequestStatus","text":"RequestStatus"},", response: ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Response","text":"Response"},") => void"],"description":[],"children":[{"type":"Enum","label":"status","isRequired":true,"signature":[{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.RequestStatus","text":"RequestStatus"}],"description":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_responder.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L53"}},{"type":"Object","label":"response","isRequired":true,"signature":[{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Response","text":"Response"}],"description":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_responder.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L53"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_responder.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L53"}},{"id":"def-public.RequestResponder.ok","type":"Function","label":"ok","signature":["(response: ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Response","text":"Response"},") => void"],"description":[],"children":[{"type":"Object","label":"response","isRequired":true,"signature":[{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Response","text":"Response"}],"description":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_responder.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L60"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_responder.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L60"}},{"id":"def-public.RequestResponder.error","type":"Function","label":"error","signature":["(response: ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Response","text":"Response"},") => void"],"description":[],"children":[{"type":"Object","label":"response","isRequired":true,"signature":[{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Response","text":"Response"}],"description":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_responder.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L64"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_responder.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L64"}}],"source":{"path":"src/plugins/inspector/common/adapters/request/request_responder.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L16"},"initialIsOpen":false}],"functions":[],"interfaces":[{"id":"def-public.InspectorViewProps","type":"Interface","label":"InspectorViewProps","signature":[{"pluginId":"inspector","scope":"public","docId":"kibInspectorPluginApi","section":"def-public.InspectorViewProps","text":"InspectorViewProps"},""],"description":["\nThe props interface that a custom inspector view component, that will be passed\nto {@link InspectorViewDescription#component}, must use."],"children":[{"id":"def-public.InspectorViewProps.adapters","type":"Uncategorized","label":"adapters","description":["\nAdapters used to open the inspector."],"source":{"path":"src/plugins/inspector/public/types.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L20"},"signature":["TAdapters"]},{"id":"def-public.InspectorViewProps.title","type":"string","label":"title","description":["\nThe title that the inspector is currently using e.g. a visualization name."],"source":{"path":"src/plugins/inspector/public/types.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L24"}},{"id":"def-public.InspectorViewProps.options","type":"Unknown","label":"options","description":["\nA set of specific options for each view."],"source":{"path":"src/plugins/inspector/public/types.ts","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L28"},"signature":["unknown"]}],"source":{"path":"src/plugins/inspector/public/types.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L16"},"initialIsOpen":false},{"id":"def-public.InspectorViewDescription","type":"Interface","label":"InspectorViewDescription","description":["\nAn object describing an inspector view."],"children":[{"id":"def-public.InspectorViewDescription.component","type":"CompoundType","label":"component","description":[],"source":{"path":"src/plugins/inspector/public/types.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L46"},"signature":["React.ComponentType<",{"pluginId":"inspector","scope":"public","docId":"kibInspectorPluginApi","section":"def-public.InspectorViewProps","text":"InspectorViewProps"},"<",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},">>"]},{"id":"def-public.InspectorViewDescription.help","type":"string","label":"help","description":[],"source":{"path":"src/plugins/inspector/public/types.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L47"},"signature":["string | undefined"]},{"id":"def-public.InspectorViewDescription.order","type":"number","label":"order","description":[],"source":{"path":"src/plugins/inspector/public/types.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L48"},"signature":["number | undefined"]},{"id":"def-public.InspectorViewDescription.shouldShow","type":"Function","label":"shouldShow","description":[],"source":{"path":"src/plugins/inspector/public/types.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L49"},"signature":["((adapters: ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},") => boolean) | undefined"]},{"id":"def-public.InspectorViewDescription.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/inspector/public/types.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L50"}}],"source":{"path":"src/plugins/inspector/public/types.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L45"},"initialIsOpen":false},{"id":"def-public.InspectorOptions","type":"Interface","label":"InspectorOptions","description":["\nOptions that can be specified when opening the inspector."],"children":[{"id":"def-public.InspectorOptions.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/inspector/public/types.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L60"},"signature":["string | undefined"]},{"id":"def-public.InspectorOptions.options","type":"Unknown","label":"options","description":[],"source":{"path":"src/plugins/inspector/public/types.ts","lineNumber":61,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L61"},"signature":["unknown"]}],"source":{"path":"src/plugins/inspector/public/types.ts","lineNumber":59,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L59"},"initialIsOpen":false},{"id":"def-public.RequestStatistic","type":"Interface","label":"RequestStatistic","description":[],"children":[{"id":"def-public.RequestStatistic.label","type":"string","label":"label","description":[],"source":{"path":"src/plugins/inspector/common/adapters/request/types.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/types.ts#L49"}},{"id":"def-public.RequestStatistic.description","type":"string","label":"description","description":[],"source":{"path":"src/plugins/inspector/common/adapters/request/types.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/types.ts#L50"},"signature":["string | undefined"]},{"id":"def-public.RequestStatistic.value","type":"Any","label":"value","description":[],"source":{"path":"src/plugins/inspector/common/adapters/request/types.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/types.ts#L51"},"signature":["any"]}],"source":{"path":"src/plugins/inspector/common/adapters/request/types.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/types.ts#L48"},"initialIsOpen":false},{"id":"def-public.RequestStatistics","type":"Interface","label":"RequestStatistics","description":[],"children":[{"id":"def-public.RequestStatistics.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/plugins/inspector/common/adapters/request/types.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/types.ts#L45"},"signature":["any"]}],"source":{"path":"src/plugins/inspector/common/adapters/request/types.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/types.ts#L44"},"initialIsOpen":false},{"id":"def-public.Adapters","type":"Interface","label":"Adapters","description":["\nThe interface that the adapters used to open an inspector have to fullfill."],"children":[{"id":"def-public.Adapters.requests","type":"Object","label":"requests","description":[],"source":{"path":"src/plugins/inspector/common/adapters/types.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/types.ts#L15"},"signature":[{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.RequestAdapter","text":"RequestAdapter"}," | undefined"]},{"id":"def-public.Adapters.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/plugins/inspector/common/adapters/types.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/types.ts#L16"},"signature":["any"]}],"source":{"path":"src/plugins/inspector/common/adapters/types.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/types.ts#L14"},"initialIsOpen":false}],"enums":[{"id":"def-public.RequestStatus","type":"Enum","label":"RequestStatus","description":["\nThe status a request can have."],"source":{"path":"src/plugins/inspector/common/adapters/request/types.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/types.ts#L12"},"initialIsOpen":false}],"misc":[{"id":"def-public.InspectorSession","type":"Type","label":"InspectorSession","description":[],"source":{"path":"src/plugins/inspector/public/types.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/types.ts#L64"},"signature":["OverlayRef"],"initialIsOpen":false}],"objects":[],"setup":{"id":"def-public.Setup","type":"Interface","label":"Setup","description":[],"children":[{"id":"def-public.Setup.registerView","type":"Function","label":"registerView","description":[],"source":{"path":"src/plugins/inspector/public/plugin.tsx","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L21"},"signature":["(view: ",{"pluginId":"inspector","scope":"public","docId":"kibInspectorPluginApi","section":"def-public.InspectorViewDescription","text":"InspectorViewDescription"},") => void"]},{"id":"def-public.Setup.__LEGACY","type":"Object","label":"__LEGACY","description":[],"source":{"path":"src/plugins/inspector/public/plugin.tsx","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L23"},"signature":["{ views: ",{"pluginId":"inspector","scope":"public","docId":"kibInspectorPluginApi","section":"def-public.InspectorViewRegistry","text":"InspectorViewRegistry"},"; }"]}],"source":{"path":"src/plugins/inspector/public/plugin.tsx","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L20"},"lifecycle":"setup","initialIsOpen":true},"start":{"id":"def-public.Start","type":"Interface","label":"Start","description":[],"children":[{"id":"def-public.Start.isAvailable","type":"Function","label":"isAvailable","description":["\nChecks if a inspector panel could be shown based on the passed adapters.\n"],"source":{"path":"src/plugins/inspector/public/plugin.tsx","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L37"},"signature":["(adapters?: ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"}," | undefined) => boolean"]},{"id":"def-public.Start.open","type":"Function","label":"open","description":["\nOpens the inspector panel for the given adapters and close any previously opened\ninspector panel. The previously panel will be closed also if no new panel will be\nopened (e.g. because of the passed adapters no view is available). You can use\n{@link InspectorSession#close} on the return value to close that opened panel again.\n"],"source":{"path":"src/plugins/inspector/public/plugin.tsx","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L51"},"signature":["(adapters: ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Adapters","text":"Adapters"},", options?: ",{"pluginId":"inspector","scope":"public","docId":"kibInspectorPluginApi","section":"def-public.InspectorOptions","text":"InspectorOptions"}," | undefined) => ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.OverlayRef","text":"OverlayRef"}]}],"source":{"path":"src/plugins/inspector/public/plugin.tsx","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/public/plugin.tsx#L28"},"lifecycle":"start","initialIsOpen":true}},"server":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"common":{"classes":[{"id":"def-common.RequestAdapter","type":"Class","label":"RequestAdapter","description":["\nAn generic inspector adapter to log requests.\nThese can be presented in the inspector using the requests view.\nThe adapter is not coupled to a specific implementation or even Elasticsearch\ninstead it offers a generic API to log requests of any kind."],"signature":[{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.RequestAdapter","text":"RequestAdapter"}," extends ","EventEmitter"],"children":[{"id":"def-common.RequestAdapter.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_adapter.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L24"}},{"id":"def-common.RequestAdapter.start","type":"Function","label":"start","signature":["(name: string, params?: ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.RequestParams","text":"RequestParams"},") => ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.RequestResponder","text":"RequestResponder"}],"description":["\nStart logging a new request into this request adapter. The new request will\nby default be in a processing state unless you explicitly finish it via\n{@link RequestResponder#finish}, {@link RequestResponder#ok} or\n{@link RequestResponder#error}.\n"],"children":[{"type":"string","label":"name","isRequired":true,"signature":["string"],"description":["The name of this request as it should be shown in the UI."],"source":{"path":"src/plugins/inspector/common/adapters/request/request_adapter.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L39"}},{"type":"Object","label":"params","isRequired":true,"signature":[{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.RequestParams","text":"RequestParams"}],"description":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_adapter.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L39"}}],"tags":["return"],"returnComment":["An instance to add information to the request and finish it."],"source":{"path":"src/plugins/inspector/common/adapters/request/request_adapter.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L39"}},{"id":"def-common.RequestAdapter.reset","type":"Function","label":"reset","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_adapter.ts","lineNumber":52,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L52"}},{"id":"def-common.RequestAdapter.resetRequest","type":"Function","label":"resetRequest","signature":["(id: string) => void"],"description":[],"children":[{"type":"string","label":"id","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_adapter.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L57"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_adapter.ts","lineNumber":57,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L57"}},{"id":"def-common.RequestAdapter.getRequests","type":"Function","label":"getRequests","signature":["() => ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Request","text":"Request"},"[]"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_adapter.ts","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L62"}}],"source":{"path":"src/plugins/inspector/common/adapters/request/request_adapter.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_adapter.ts#L21"},"initialIsOpen":false},{"id":"def-common.RequestResponder","type":"Class","label":"RequestResponder","description":["\nAn API to specify information about a specific request that will be logged.\nCreate a new instance to log a request using {@link RequestAdapter#start}."],"children":[{"id":"def-common.RequestResponder.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"request","isRequired":true,"signature":[{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Request","text":"Request"}],"description":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_responder.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L20"}},{"type":"Function","label":"onChange","isRequired":true,"signature":["() => void"],"description":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_responder.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L20"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_responder.ts","lineNumber":20,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L20"}},{"id":"def-common.RequestResponder.json","type":"Function","label":"json","signature":["(reqJson: object) => ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.RequestResponder","text":"RequestResponder"}],"description":[],"children":[{"type":"Uncategorized","label":"reqJson","isRequired":true,"signature":["object"],"description":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_responder.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L25"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_responder.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L25"}},{"id":"def-common.RequestResponder.stats","type":"Function","label":"stats","signature":["(stats: ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.RequestStatistics","text":"RequestStatistics"},") => ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.RequestResponder","text":"RequestResponder"}],"description":[],"children":[{"type":"Object","label":"stats","isRequired":true,"signature":[{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.RequestStatistics","text":"RequestStatistics"}],"description":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_responder.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L31"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_responder.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L31"}},{"id":"def-common.RequestResponder.finish","type":"Function","label":"finish","signature":["(status: ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.RequestStatus","text":"RequestStatus"},", response: ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Response","text":"Response"},") => void"],"description":[],"children":[{"type":"Enum","label":"status","isRequired":true,"signature":[{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.RequestStatus","text":"RequestStatus"}],"description":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_responder.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L53"}},{"type":"Object","label":"response","isRequired":true,"signature":[{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Response","text":"Response"}],"description":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_responder.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L53"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_responder.ts","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L53"}},{"id":"def-common.RequestResponder.ok","type":"Function","label":"ok","signature":["(response: ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Response","text":"Response"},") => void"],"description":[],"children":[{"type":"Object","label":"response","isRequired":true,"signature":[{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Response","text":"Response"}],"description":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_responder.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L60"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_responder.ts","lineNumber":60,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L60"}},{"id":"def-common.RequestResponder.error","type":"Function","label":"error","signature":["(response: ",{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Response","text":"Response"},") => void"],"description":[],"children":[{"type":"Object","label":"response","isRequired":true,"signature":[{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.Response","text":"Response"}],"description":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_responder.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L64"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/inspector/common/adapters/request/request_responder.ts","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L64"}}],"source":{"path":"src/plugins/inspector/common/adapters/request/request_responder.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/request_responder.ts#L16"},"initialIsOpen":false}],"functions":[],"interfaces":[{"id":"def-common.Adapters","type":"Interface","label":"Adapters","description":["\nThe interface that the adapters used to open an inspector have to fullfill."],"children":[{"id":"def-common.Adapters.requests","type":"Object","label":"requests","description":[],"source":{"path":"src/plugins/inspector/common/adapters/types.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/types.ts#L15"},"signature":[{"pluginId":"inspector","scope":"common","docId":"kibInspectorPluginApi","section":"def-common.RequestAdapter","text":"RequestAdapter"}," | undefined"]},{"id":"def-common.Adapters.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/plugins/inspector/common/adapters/types.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/types.ts#L16"},"signature":["any"]}],"source":{"path":"src/plugins/inspector/common/adapters/types.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/types.ts#L14"},"initialIsOpen":false},{"id":"def-common.RequestStatistic","type":"Interface","label":"RequestStatistic","description":[],"children":[{"id":"def-common.RequestStatistic.label","type":"string","label":"label","description":[],"source":{"path":"src/plugins/inspector/common/adapters/request/types.ts","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/types.ts#L49"}},{"id":"def-common.RequestStatistic.description","type":"string","label":"description","description":[],"source":{"path":"src/plugins/inspector/common/adapters/request/types.ts","lineNumber":50,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/types.ts#L50"},"signature":["string | undefined"]},{"id":"def-common.RequestStatistic.value","type":"Any","label":"value","description":[],"source":{"path":"src/plugins/inspector/common/adapters/request/types.ts","lineNumber":51,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/types.ts#L51"},"signature":["any"]}],"source":{"path":"src/plugins/inspector/common/adapters/request/types.ts","lineNumber":48,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/types.ts#L48"},"initialIsOpen":false},{"id":"def-common.RequestStatistics","type":"Interface","label":"RequestStatistics","description":[],"children":[{"id":"def-common.RequestStatistics.Unnamed","type":"Any","label":"Unnamed","description":[],"source":{"path":"src/plugins/inspector/common/adapters/request/types.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/types.ts#L45"},"signature":["any"]}],"source":{"path":"src/plugins/inspector/common/adapters/request/types.ts","lineNumber":44,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/types.ts#L44"},"initialIsOpen":false}],"enums":[{"id":"def-common.RequestStatus","type":"Enum","label":"RequestStatus","description":["\nThe status a request can have."],"source":{"path":"src/plugins/inspector/common/adapters/request/types.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/inspector/common/adapters/request/types.ts#L12"},"initialIsOpen":false}],"misc":[],"objects":[]}} \ No newline at end of file diff --git a/api_docs/inspector.mdx b/api_docs/inspector.mdx new file mode 100644 index 0000000000000..f2e895d9c1bb0 --- /dev/null +++ b/api_docs/inspector.mdx @@ -0,0 +1,34 @@ +--- +id: kibInspectorPluginApi +slug: /kibana-dev-docs/inspectorPluginApi +title: inspector +image: https://source.unsplash.com/400x175/?github +summary: API docs for the inspector plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'inspector'] +--- + +import inspectorObj from './inspector.json'; + +## Client + +### Setup + +### Start + +### Classes + +### Interfaces + +### Enums + +### Consts, variables and types + +## Common + +### Classes + +### Interfaces + +### Enums + diff --git a/api_docs/kibana_legacy.json b/api_docs/kibana_legacy.json new file mode 100644 index 0000000000000..3c4fe9793974f --- /dev/null +++ b/api_docs/kibana_legacy.json @@ -0,0 +1 @@ +{"id":"kibanaLegacy","client":{"classes":[{"id":"def-public.KibanaLegacyPlugin","type":"Class","label":"KibanaLegacyPlugin","description":[],"children":[{"id":"def-public.KibanaLegacyPlugin.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"initializerContext","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.PluginInitializerContext","text":"PluginInitializerContext"},">"],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/plugin.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/plugin.ts#L15"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_legacy/public/plugin.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/plugin.ts#L15"}},{"id":"def-public.KibanaLegacyPlugin.setup","type":"Function","label":"setup","signature":["(core: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreSetup","text":"CoreSetup"},"<{}, { dashboardConfig: ",{"pluginId":"kibanaLegacy","scope":"public","docId":"kibKibanaLegacyPluginApi","section":"def-public.DashboardConfig","text":"DashboardConfig"},"; loadFontAwesome: () => Promise; config: Readonly<{} & { defaultAppId: string; }>; }>) => {}"],"description":[],"children":[{"type":"Object","label":"core","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreSetup","text":"CoreSetup"},"<{}, { dashboardConfig: ",{"pluginId":"kibanaLegacy","scope":"public","docId":"kibKibanaLegacyPluginApi","section":"def-public.DashboardConfig","text":"DashboardConfig"},"; loadFontAwesome: () => Promise; config: Readonly<{} & { defaultAppId: string; }>; }>"],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/plugin.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/plugin.ts#L17"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_legacy/public/plugin.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/plugin.ts#L17"}},{"id":"def-public.KibanaLegacyPlugin.start","type":"Function","label":"start","signature":["({ application, http: { basePath }, uiSettings }: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreStart","text":"CoreStart"},") => { dashboardConfig: ",{"pluginId":"kibanaLegacy","scope":"public","docId":"kibKibanaLegacyPluginApi","section":"def-public.DashboardConfig","text":"DashboardConfig"},"; loadFontAwesome: () => Promise; config: Readonly<{} & { defaultAppId: string; }>; }"],"description":[],"children":[{"type":"Object","label":"{ application, http: { basePath }, uiSettings }","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreStart","text":"CoreStart"}],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/plugin.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/plugin.ts#L21"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_legacy/public/plugin.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/plugin.ts#L21"}}],"source":{"path":"src/plugins/kibana_legacy/public/plugin.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/plugin.ts#L14"},"initialIsOpen":false},{"id":"def-public.ToastNotifications","type":"Class","label":"ToastNotifications","description":[],"children":[{"id":"def-public.ToastNotifications.list","type":"Array","label":"list","description":[],"source":{"path":"src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L12"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Toast","text":"Toast"},"[]"]},{"id":"def-public.ToastNotifications.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"toasts","isRequired":true,"signature":["Pick<",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastsApi","text":"ToastsApi"},", \"get$\" | \"add\" | \"remove\" | \"addSuccess\" | \"addWarning\" | \"addDanger\" | \"addError\" | \"addInfo\">"],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L16"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L16"}},{"id":"def-public.ToastNotifications.onChange","type":"Function","children":[{"type":"Function","label":"callback","isRequired":true,"signature":["() => void"],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L26"}}],"signature":["(callback: () => void) => void"],"description":[],"label":"onChange","source":{"path":"src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L26"},"returnComment":[]},{"id":"def-public.ToastNotifications.add","type":"Function","children":[{"type":"CompoundType","label":"toastOrTitle","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastInput","text":"ToastInput"}],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L30"}}],"signature":["(toastOrTitle: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastInput","text":"ToastInput"},") => ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Toast","text":"Toast"}],"description":[],"label":"add","source":{"path":"src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L30"},"returnComment":[]},{"id":"def-public.ToastNotifications.remove","type":"Function","children":[{"type":"CompoundType","label":"toast","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Toast","text":"Toast"}],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L31"}}],"signature":["(toast: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Toast","text":"Toast"},") => void"],"description":[],"label":"remove","source":{"path":"src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L31"},"returnComment":[]},{"id":"def-public.ToastNotifications.addSuccess","type":"Function","children":[{"type":"CompoundType","label":"toastOrTitle","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastInput","text":"ToastInput"}],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L32"}}],"signature":["(toastOrTitle: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastInput","text":"ToastInput"},") => ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Toast","text":"Toast"}],"description":[],"label":"addSuccess","source":{"path":"src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L32"},"returnComment":[]},{"id":"def-public.ToastNotifications.addWarning","type":"Function","children":[{"type":"CompoundType","label":"toastOrTitle","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastInput","text":"ToastInput"}],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L33"}}],"signature":["(toastOrTitle: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastInput","text":"ToastInput"},") => ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Toast","text":"Toast"}],"description":[],"label":"addWarning","source":{"path":"src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L33"},"returnComment":[]},{"id":"def-public.ToastNotifications.addDanger","type":"Function","children":[{"type":"CompoundType","label":"toastOrTitle","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastInput","text":"ToastInput"}],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L34"}}],"signature":["(toastOrTitle: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ToastInput","text":"ToastInput"},") => ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Toast","text":"Toast"}],"description":[],"label":"addDanger","source":{"path":"src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L34"},"returnComment":[]},{"id":"def-public.ToastNotifications.addError","type":"Function","children":[{"type":"Object","label":"error","isRequired":true,"signature":["Error"],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L35"}},{"type":"Object","label":"options","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ErrorToastOptions","text":"ErrorToastOptions"}],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L35"}}],"signature":["(error: Error, options: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.ErrorToastOptions","text":"ErrorToastOptions"},") => ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.Toast","text":"Toast"}],"description":[],"label":"addError","source":{"path":"src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L35"},"returnComment":[]}],"source":{"path":"src/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/toasts/toast_notifications.ts#L11"},"initialIsOpen":false}],"functions":[{"id":"def-public.initAngularBootstrap","type":"Function","label":"initAngularBootstrap","description":[],"source":{"path":"src/plugins/kibana_legacy/public/angular_bootstrap/index.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular_bootstrap/index.ts#L15"},"signature":["() => void"],"initialIsOpen":false},{"id":"def-public.PaginateDirectiveProvider","type":"Function","label":"PaginateDirectiveProvider","signature":["($parse: any, $compile: any) => any"],"description":[],"children":[{"type":"Any","label":"$parse","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/paginate/paginate.d.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/paginate/paginate.d.ts#L9"}},{"type":"Any","label":"$compile","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/paginate/paginate.d.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/paginate/paginate.d.ts#L9"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_legacy/public/paginate/paginate.d.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/paginate/paginate.d.ts#L9"},"initialIsOpen":false},{"id":"def-public.PaginateControlsDirectiveProvider","type":"Function","label":"PaginateControlsDirectiveProvider","signature":["() => any"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_legacy/public/paginate/paginate.d.ts","lineNumber":10,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/paginate/paginate.d.ts#L10"},"initialIsOpen":false},{"id":"def-public.PromiseServiceCreator","type":"Function","label":"PromiseServiceCreator","signature":["($q: unknown, $timeout: unknown) => (fn: unknown) => unknown"],"description":[],"children":[{"type":"Unknown","label":"$q","isRequired":true,"signature":["unknown"],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/angular/promises.d.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/promises.d.ts#L9"}},{"type":"Unknown","label":"$timeout","isRequired":true,"signature":["unknown"],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/angular/promises.d.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/promises.d.ts#L9"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_legacy/public/angular/promises.d.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/promises.d.ts#L9"},"initialIsOpen":false},{"id":"def-public.watchMultiDecorator","type":"Function","label":"watchMultiDecorator","signature":["($provide: unknown) => void"],"description":[],"children":[{"type":"Unknown","label":"$provide","isRequired":true,"signature":["unknown"],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/angular/watch_multi.d.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/watch_multi.d.ts#L9"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_legacy/public/angular/watch_multi.d.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/watch_multi.d.ts#L9"},"initialIsOpen":false},{"id":"def-public.createTopNavHelper","type":"Function","label":"createTopNavHelper","description":[],"source":{"path":"src/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts#L14"},"signature":["(options: unknown) => angular.Injectable>"],"initialIsOpen":false},{"id":"def-public.loadKbnTopNavDirectives","type":"Function","label":"loadKbnTopNavDirectives","signature":["(navUi: unknown) => void"],"description":[],"children":[{"type":"Unknown","label":"navUi","isRequired":true,"signature":["unknown"],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts#L17"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts#L17"},"initialIsOpen":false},{"id":"def-public.subscribeWithScope","type":"Function","label":"subscribeWithScope","signature":["($scope: angular.IScope, observable: ","Observable",", observer: ","NextObserver"," | ","ErrorObserver"," | ","CompletionObserver"," | undefined, fatalError: FatalErrorFn | undefined) => ","Subscription"],"description":["\nSubscribe to an observable at a $scope, ensuring that the digest cycle\nis run for subscriber hooks and routing errors to fatalError if not handled."],"children":[{"type":"Object","label":"$scope","isRequired":true,"signature":["angular.IScope"],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts#L40"}},{"type":"Object","label":"observable","isRequired":true,"signature":["Observable",""],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts#L41"}},{"type":"CompoundType","label":"observer","isRequired":false,"signature":["NextObserver"," | ","ErrorObserver"," | ","CompletionObserver"," | undefined"],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts#L42"}},{"type":"Function","label":"fatalError","isRequired":false,"signature":["FatalErrorFn | undefined"],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts#L43"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/subscribe_with_scope.ts#L39"},"initialIsOpen":false},{"id":"def-public.configureAppAngularModule","type":"Function","children":[{"type":"Object","label":"angularModule","isRequired":true,"signature":["angular.IModule"],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/angular/angular_config.tsx","lineNumber":63,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L63"}},{"id":"def-public.configureAppAngularModule.newPlatform","type":"Object","label":"newPlatform","description":[],"children":[{"id":"def-public.configureAppAngularModule.newPlatform.core","type":"Object","label":"core","description":[],"source":{"path":"src/plugins/kibana_legacy/public/angular/angular_config.tsx","lineNumber":65,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L65"},"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreStart","text":"CoreStart"}]},{"id":"def-public.configureAppAngularModule.newPlatform.env","type":"Object","label":"env","description":[],"source":{"path":"src/plugins/kibana_legacy/public/angular/angular_config.tsx","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L66"},"signature":["{ mode: Readonly<","EnvironmentMode",">; packageInfo: Readonly<","PackageInfo",">; }"]}],"source":{"path":"src/plugins/kibana_legacy/public/angular/angular_config.tsx","lineNumber":64,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L64"}},{"type":"boolean","label":"isLocalAngular","isRequired":true,"signature":["boolean"],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/angular/angular_config.tsx","lineNumber":71,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L71"}},{"type":"Function","label":"getHistory","isRequired":false,"signature":["(() => ","History",") | undefined"],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/angular/angular_config.tsx","lineNumber":72,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L72"}}],"signature":["(angularModule: angular.IModule, newPlatform: { core: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreStart","text":"CoreStart"},"; readonly env: { mode: Readonly<","EnvironmentMode",">; packageInfo: Readonly<","PackageInfo",">; }; }, isLocalAngular: boolean, getHistory?: (() => ","History",") | undefined) => void"],"description":[],"label":"configureAppAngularModule","source":{"path":"src/plugins/kibana_legacy/public/angular/angular_config.tsx","lineNumber":62,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L62"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.$setupXsrfRequestInterceptor","type":"Function","children":[{"type":"string","label":"version","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/angular/angular_config.tsx","lineNumber":136,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L136"}}],"signature":["(version: string) => ($httpProvider: angular.IHttpProvider) => void"],"description":[],"label":"$setupXsrfRequestInterceptor","source":{"path":"src/plugins/kibana_legacy/public/angular/angular_config.tsx","lineNumber":136,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L136"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.formatESMsg","type":"Function","children":[{"type":"CompoundType","label":"err","isRequired":true,"signature":["string | Record"],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/notify/lib/format_es_msg.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/format_es_msg.ts#L18"}}],"signature":["(err: string | Record) => string | undefined"],"description":["\nUtilize the extended error information returned from elasticsearch"],"label":"formatESMsg","source":{"path":"src/plugins/kibana_legacy/public/notify/lib/format_es_msg.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/format_es_msg.ts#L18"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.formatMsg","type":"Function","label":"formatMsg","signature":["(err: string | Record, source: string) => string"],"description":["\nFormats the error message from an error object, extended elasticsearch\nobject or simple string; prepends optional second parameter to the message"],"children":[{"type":"CompoundType","label":"err","isRequired":true,"signature":["string | Record"],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/notify/lib/format_msg.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/format_msg.ts#L21"}},{"type":"string","label":"source","isRequired":true,"signature":["string"],"description":["- Prefix for message indicating source (optional)"],"source":{"path":"src/plugins/kibana_legacy/public/notify/lib/format_msg.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/format_msg.ts#L21"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_legacy/public/notify/lib/format_msg.ts","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/format_msg.ts#L21"},"initialIsOpen":false},{"id":"def-public.formatStack","type":"Function","label":"formatStack","signature":["(err: Record) => any"],"description":[],"children":[{"type":"Object","label":"err","isRequired":true,"signature":["Record"],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/notify/lib/format_stack.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/format_stack.ts#L12"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_legacy/public/notify/lib/format_stack.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/format_stack.ts#L12"},"initialIsOpen":false},{"id":"def-public.isAngularHttpError","type":"Function","label":"isAngularHttpError","signature":["(error: any) => boolean"],"description":[],"children":[{"type":"Any","label":"error","isRequired":true,"signature":["any"],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts#L14"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts#L14"},"initialIsOpen":false},{"id":"def-public.formatAngularHttpError","type":"Function","label":"formatAngularHttpError","signature":["(error: ",{"pluginId":"kibanaLegacy","scope":"public","docId":"kibKibanaLegacyPluginApi","section":"def-public.AngularHttpError","text":"AngularHttpError"},") => string"],"description":[],"children":[{"type":"Object","label":"error","isRequired":true,"signature":[{"pluginId":"kibanaLegacy","scope":"public","docId":"kibKibanaLegacyPluginApi","section":"def-public.AngularHttpError","text":"AngularHttpError"}],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts#L24"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts#L24"},"initialIsOpen":false},{"id":"def-public.addFatalError","type":"Function","label":"addFatalError","signature":["(fatalErrors: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.FatalErrorsSetup","text":"FatalErrorsSetup"},", error: string | Error | ",{"pluginId":"kibanaLegacy","scope":"public","docId":"kibKibanaLegacyPluginApi","section":"def-public.AngularHttpError","text":"AngularHttpError"},", location: string | undefined) => void"],"description":[],"children":[{"type":"Object","label":"fatalErrors","isRequired":true,"signature":[{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.FatalErrorsSetup","text":"FatalErrorsSetup"}],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts#L17"}},{"type":"CompoundType","label":"error","isRequired":true,"signature":["string | Error | ",{"pluginId":"kibanaLegacy","scope":"public","docId":"kibKibanaLegacyPluginApi","section":"def-public.AngularHttpError","text":"AngularHttpError"}],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts#L18"}},{"type":"string","label":"location","isRequired":false,"signature":["string | undefined"],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts#L19"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/add_fatal_error.ts#L16"},"initialIsOpen":false},{"id":"def-public.PrivateProvider","type":"Function","label":"PrivateProvider","signature":["() => angular.IServiceProvider"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_legacy/public/utils/private.d.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/utils/private.d.ts#L13"},"initialIsOpen":false},{"id":"def-public.registerListenEventListener","type":"Function","label":"registerListenEventListener","signature":["($rootScope: unknown) => void"],"description":[],"children":[{"type":"Unknown","label":"$rootScope","isRequired":true,"signature":["unknown"],"description":[],"source":{"path":"src/plugins/kibana_legacy/public/utils/register_listen_event_listener.d.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/utils/register_listen_event_listener.d.ts#L9"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_legacy/public/utils/register_listen_event_listener.d.ts","lineNumber":9,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/utils/register_listen_event_listener.d.ts#L9"},"initialIsOpen":false},{"id":"def-public.addSystemApiHeader","type":"Function","label":"addSystemApiHeader","signature":["(originalHeaders: Record) => { \"kbn-system-request\": boolean; }"],"description":["\nAdds a custom header designating request as system API"],"children":[{"type":"Object","label":"originalHeaders","isRequired":true,"signature":["Record"],"description":["Object representing set of headers"],"source":{"path":"src/plugins/kibana_legacy/public/utils/system_api.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/utils/system_api.ts#L19"}}],"tags":["return"],"returnComment":["Object representing set of headers, with system API header added in"],"source":{"path":"src/plugins/kibana_legacy/public/utils/system_api.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/utils/system_api.ts#L19"},"initialIsOpen":false},{"id":"def-public.isSystemApiRequest","type":"Function","label":"isSystemApiRequest","signature":["(request: angular.IRequestConfig) => boolean | undefined"],"description":["\nReturns true if request is a system API request; false otherwise\n"],"children":[{"type":"Object","label":"request","isRequired":true,"signature":["angular.IRequestConfig"],"description":["Object Request object created by $http service"],"source":{"path":"src/plugins/kibana_legacy/public/utils/system_api.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/utils/system_api.ts#L35"}}],"tags":["return"],"returnComment":["true if request is a system API request; false otherwise"],"source":{"path":"src/plugins/kibana_legacy/public/utils/system_api.ts","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/utils/system_api.ts#L35"},"initialIsOpen":false}],"interfaces":[{"id":"def-public.RouteConfiguration","type":"Interface","label":"RouteConfiguration","description":[],"children":[{"id":"def-public.RouteConfiguration.controller","type":"CompoundType","label":"controller","description":[],"source":{"path":"src/plugins/kibana_legacy/public/angular/angular_config.tsx","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L29"},"signature":["string | ((...args: any[]) => void) | undefined"]},{"id":"def-public.RouteConfiguration.redirectTo","type":"string","label":"redirectTo","description":[],"source":{"path":"src/plugins/kibana_legacy/public/angular/angular_config.tsx","lineNumber":30,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L30"},"signature":["string | undefined"]},{"id":"def-public.RouteConfiguration.resolveRedirectTo","type":"Function","label":"resolveRedirectTo","description":[],"source":{"path":"src/plugins/kibana_legacy/public/angular/angular_config.tsx","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L31"},"signature":["((...args: any[]) => void) | undefined"]},{"id":"def-public.RouteConfiguration.reloadOnSearch","type":"CompoundType","label":"reloadOnSearch","description":[],"source":{"path":"src/plugins/kibana_legacy/public/angular/angular_config.tsx","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L32"},"signature":["boolean | undefined"]},{"id":"def-public.RouteConfiguration.reloadOnUrl","type":"CompoundType","label":"reloadOnUrl","description":[],"source":{"path":"src/plugins/kibana_legacy/public/angular/angular_config.tsx","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L33"},"signature":["boolean | undefined"]},{"id":"def-public.RouteConfiguration.outerAngularWrapperRoute","type":"CompoundType","label":"outerAngularWrapperRoute","description":[],"source":{"path":"src/plugins/kibana_legacy/public/angular/angular_config.tsx","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L34"},"signature":["boolean | undefined"]},{"id":"def-public.RouteConfiguration.resolve","type":"Uncategorized","label":"resolve","description":[],"source":{"path":"src/plugins/kibana_legacy/public/angular/angular_config.tsx","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L35"},"signature":["object | undefined"]},{"id":"def-public.RouteConfiguration.template","type":"string","label":"template","description":[],"source":{"path":"src/plugins/kibana_legacy/public/angular/angular_config.tsx","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L36"},"signature":["string | undefined"]},{"id":"def-public.RouteConfiguration.k7Breadcrumbs","type":"Function","label":"k7Breadcrumbs","description":[],"source":{"path":"src/plugins/kibana_legacy/public/angular/angular_config.tsx","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L37"},"signature":["((...args: any[]) => ","EuiBreadcrumb","[]) | undefined"]},{"id":"def-public.RouteConfiguration.requireUICapability","type":"string","label":"requireUICapability","description":[],"source":{"path":"src/plugins/kibana_legacy/public/angular/angular_config.tsx","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L38"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/kibana_legacy/public/angular/angular_config.tsx","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/angular_config.tsx#L28"},"initialIsOpen":false}],"enums":[],"misc":[{"id":"def-public.KibanaLegacySetup","type":"Type","label":"KibanaLegacySetup","description":[],"source":{"path":"src/plugins/kibana_legacy/public/plugin.ts","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/plugin.ts#L45"},"signature":["{}"],"initialIsOpen":false},{"id":"def-public.KibanaLegacyStart","type":"Type","label":"KibanaLegacyStart","description":[],"source":{"path":"src/plugins/kibana_legacy/public/plugin.ts","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/plugin.ts#L46"},"signature":["{ dashboardConfig: ","DashboardConfig","; loadFontAwesome: () => Promise; config: Readonly<{} & { defaultAppId: string; }>; }"],"initialIsOpen":false},{"id":"def-public.createTopNavDirective","type":"CompoundType","label":"createTopNavDirective","description":[],"source":{"path":"src/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/angular/kbn_top_nav.d.ts#L11"},"signature":["angular.Injectable>"],"initialIsOpen":false},{"id":"def-public.AngularHttpError","type":"Type","label":"AngularHttpError","description":[],"source":{"path":"src/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/notify/lib/format_angular_http_error.ts#L12"},"signature":["IHttpResponse<{ message: string; }>"],"initialIsOpen":false},{"id":"def-public.KbnAccessibleClickProvider","type":"CompoundType","label":"KbnAccessibleClickProvider","description":[],"source":{"path":"src/plugins/kibana_legacy/public/utils/kbn_accessible_click.d.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/utils/kbn_accessible_click.d.ts#L11"},"signature":["angular.Injectable>"],"initialIsOpen":false},{"id":"def-public.IPrivate","type":"Type","label":"IPrivate","description":[],"source":{"path":"src/plugins/kibana_legacy/public/utils/private.d.ts","lineNumber":11,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_legacy/public/utils/private.d.ts#L11"},"signature":["(provider: (...injectable: any[]) => T) => T"],"initialIsOpen":false}],"objects":[]},"server":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]},"common":{"classes":[],"functions":[],"interfaces":[],"enums":[],"misc":[],"objects":[]}} \ No newline at end of file diff --git a/api_docs/kibana_legacy.mdx b/api_docs/kibana_legacy.mdx new file mode 100644 index 0000000000000..69668a1961333 --- /dev/null +++ b/api_docs/kibana_legacy.mdx @@ -0,0 +1,22 @@ +--- +id: kibKibanaLegacyPluginApi +slug: /kibana-dev-docs/kibanaLegacyPluginApi +title: kibanaLegacy +image: https://source.unsplash.com/400x175/?github +summary: API docs for the kibanaLegacy plugin +date: 2020-11-16 +tags: ['contributor', 'dev', 'apidocs', 'kibana', 'kibanaLegacy'] +--- + +import kibanaLegacyObj from './kibana_legacy.json'; + +## Client + +### Functions + +### Classes + +### Interfaces + +### Consts, variables and types + diff --git a/api_docs/kibana_react.json b/api_docs/kibana_react.json new file mode 100644 index 0000000000000..6214e53b7bcb8 --- /dev/null +++ b/api_docs/kibana_react.json @@ -0,0 +1 @@ +{"id":"kibanaReact","client":{"classes":[{"id":"def-public.ValidatedDualRange","type":"Class","label":"ValidatedDualRange","description":[],"signature":[{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.ValidatedDualRange","text":"ValidatedDualRange"}," extends React.Component"],"children":[{"id":"def-public.ValidatedDualRange.defaultProps","type":"Object","children":[{"id":"def-public.ValidatedDualRange.defaultProps.allowEmptyRange","type":"boolean","label":"allowEmptyRange","description":[],"source":{"path":"src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/validated_range/validated_dual_range.tsx#L41"},"signature":["true"]},{"id":"def-public.ValidatedDualRange.defaultProps.fullWidth","type":"boolean","label":"fullWidth","description":[],"source":{"path":"src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx","lineNumber":42,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/validated_range/validated_dual_range.tsx#L42"},"signature":["false"]},{"id":"def-public.ValidatedDualRange.defaultProps.compressed","type":"boolean","label":"compressed","description":[],"source":{"path":"src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/validated_range/validated_dual_range.tsx#L43"},"signature":["false"]}],"description":[],"label":"defaultProps","source":{"path":"src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/validated_range/validated_dual_range.tsx#L40"}},{"id":"def-public.ValidatedDualRange.getDerivedStateFromProps","type":"Function","label":"getDerivedStateFromProps","signature":["typeof ",{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.ValidatedDualRange","text":"ValidatedDualRange"},".getDerivedStateFromProps"],"description":[],"children":[{"type":"Object","label":"nextProps","isRequired":true,"signature":["Props"],"description":[],"source":{"path":"src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/validated_range/validated_dual_range.tsx#L46"}},{"type":"Object","label":"prevState","isRequired":true,"signature":["State"],"description":[],"source":{"path":"src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/validated_range/validated_dual_range.tsx#L46"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/validated_range/validated_dual_range.tsx#L46"}},{"id":"def-public.ValidatedDualRange.state","type":"Object","children":[],"description":[],"label":"state","source":{"path":"src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx","lineNumber":66,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/validated_range/validated_dual_range.tsx#L66"}},{"id":"def-public.ValidatedDualRange._onChange","type":"Function","children":[{"type":"Object","label":"value","isRequired":true,"signature":["[React.ReactText, React.ReactText]"],"description":[],"source":{"path":"src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/validated_range/validated_dual_range.tsx#L68"}}],"signature":["(value: [React.ReactText, React.ReactText]) => void"],"description":[],"label":"_onChange","source":{"path":"src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/validated_range/validated_dual_range.tsx#L68"},"returnComment":[]},{"id":"def-public.ValidatedDualRange.render","type":"Function","label":"render","signature":["() => JSX.Element"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx","lineNumber":87,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/validated_range/validated_dual_range.tsx#L87"}}],"source":{"path":"src/plugins/kibana_react/public/validated_range/validated_dual_range.tsx","lineNumber":39,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/validated_range/validated_dual_range.tsx#L39"},"initialIsOpen":false},{"id":"def-public.TableListView","type":"Class","label":"TableListView","description":[],"signature":[{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.TableListView","text":"TableListView"}," extends React.Component<",{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.TableListViewProps","text":"TableListViewProps"},", ",{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.TableListViewState","text":"TableListViewState"},", any>"],"children":[{"id":"def-public.TableListView.Unnamed","type":"Function","label":"Constructor","signature":["any"],"description":[],"children":[{"type":"Object","label":"props","isRequired":true,"signature":[{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.TableListViewProps","text":"TableListViewProps"}],"description":[],"source":{"path":"src/plugins/kibana_react/public/table_list_view/table_list_view.tsx","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L90"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_react/public/table_list_view/table_list_view.tsx","lineNumber":90,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L90"}},{"id":"def-public.TableListView.UNSAFE_componentWillMount","type":"Function","label":"UNSAFE_componentWillMount","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_react/public/table_list_view/table_list_view.tsx","lineNumber":111,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L111"}},{"id":"def-public.TableListView.componentWillUnmount","type":"Function","label":"componentWillUnmount","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_react/public/table_list_view/table_list_view.tsx","lineNumber":115,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L115"}},{"id":"def-public.TableListView.componentDidMount","type":"Function","label":"componentDidMount","signature":["() => void"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_react/public/table_list_view/table_list_view.tsx","lineNumber":120,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L120"}},{"id":"def-public.TableListView.debouncedFetch","type":"Function","label":"debouncedFetch","description":[],"source":{"path":"src/plugins/kibana_react/public/table_list_view/table_list_view.tsx","lineNumber":124,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L124"},"signature":["((filter: string) => Promise) & _.Cancelable"]},{"id":"def-public.TableListView.fetchItems","type":"Function","children":[],"signature":["() => void"],"description":[],"label":"fetchItems","source":{"path":"src/plugins/kibana_react/public/table_list_view/table_list_view.tsx","lineNumber":156,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L156"},"returnComment":[]},{"id":"def-public.TableListView.deleteSelectedItems","type":"Function","children":[],"signature":["() => Promise"],"description":[],"label":"deleteSelectedItems","source":{"path":"src/plugins/kibana_react/public/table_list_view/table_list_view.tsx","lineNumber":166,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L166"},"returnComment":[]},{"id":"def-public.TableListView.closeDeleteModal","type":"Function","children":[],"signature":["() => void"],"description":[],"label":"closeDeleteModal","source":{"path":"src/plugins/kibana_react/public/table_list_view/table_list_view.tsx","lineNumber":196,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L196"},"returnComment":[]},{"id":"def-public.TableListView.openDeleteModal","type":"Function","children":[],"signature":["() => void"],"description":[],"label":"openDeleteModal","source":{"path":"src/plugins/kibana_react/public/table_list_view/table_list_view.tsx","lineNumber":200,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L200"},"returnComment":[]},{"id":"def-public.TableListView.setFilter","type":"Function","label":"setFilter","signature":["({ queryText }: { queryText: string; }) => void"],"description":[],"children":[{"id":"def-public.TableListView.setFilter.{-queryText }","type":"Object","label":"{ queryText }","description":[],"children":[{"id":"def-public.TableListView.setFilter.{-queryText }.queryText","type":"string","label":"queryText","description":[],"source":{"path":"src/plugins/kibana_react/public/table_list_view/table_list_view.tsx","lineNumber":204,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L204"}}],"source":{"path":"src/plugins/kibana_react/public/table_list_view/table_list_view.tsx","lineNumber":204,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L204"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_react/public/table_list_view/table_list_view.tsx","lineNumber":204,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L204"}},{"id":"def-public.TableListView.hasNoItems","type":"Function","label":"hasNoItems","signature":["() => boolean"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_react/public/table_list_view/table_list_view.tsx","lineNumber":215,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L215"}},{"id":"def-public.TableListView.renderConfirmDeleteModal","type":"Function","label":"renderConfirmDeleteModal","signature":["() => JSX.Element"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_react/public/table_list_view/table_list_view.tsx","lineNumber":223,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L223"}},{"id":"def-public.TableListView.renderListingLimitWarning","type":"Function","label":"renderListingLimitWarning","signature":["() => JSX.Element | undefined"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_react/public/table_list_view/table_list_view.tsx","lineNumber":277,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L277"}},{"id":"def-public.TableListView.renderFetchError","type":"Function","label":"renderFetchError","signature":["() => JSX.Element | undefined"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_react/public/table_list_view/table_list_view.tsx","lineNumber":319,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L319"}},{"id":"def-public.TableListView.renderNoItemsMessage","type":"Function","label":"renderNoItemsMessage","signature":["() => JSX.Element"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_react/public/table_list_view/table_list_view.tsx","lineNumber":350,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L350"}},{"id":"def-public.TableListView.renderToolsLeft","type":"Function","label":"renderToolsLeft","signature":["() => JSX.Element | undefined"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_react/public/table_list_view/table_list_view.tsx","lineNumber":364,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L364"}},{"id":"def-public.TableListView.renderTable","type":"Function","label":"renderTable","signature":["() => JSX.Element"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_react/public/table_list_view/table_list_view.tsx","lineNumber":395,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L395"}},{"id":"def-public.TableListView.renderListingOrEmptyState","type":"Function","label":"renderListingOrEmptyState","signature":["() => JSX.Element"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_react/public/table_list_view/table_list_view.tsx","lineNumber":475,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L475"}},{"id":"def-public.TableListView.renderListing","type":"Function","label":"renderListing","signature":["() => JSX.Element"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_react/public/table_list_view/table_list_view.tsx","lineNumber":483,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L483"}},{"id":"def-public.TableListView.renderPageContent","type":"Function","label":"renderPageContent","signature":["() => JSX.Element | undefined"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_react/public/table_list_view/table_list_view.tsx","lineNumber":528,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L528"}},{"id":"def-public.TableListView.render","type":"Function","label":"render","signature":["() => JSX.Element"],"description":[],"children":[],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_react/public/table_list_view/table_list_view.tsx","lineNumber":540,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L540"}}],"source":{"path":"src/plugins/kibana_react/public/table_list_view/table_list_view.tsx","lineNumber":86,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/table_list_view/table_list_view.tsx#L86"},"initialIsOpen":false}],"functions":[{"id":"def-public.Markdown","type":"Function","children":[{"type":"Object","label":"props","isRequired":true,"signature":[{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.MarkdownProps","text":"MarkdownProps"}],"description":[],"source":{"path":"src/plugins/kibana_react/public/markdown/index.tsx","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/markdown/index.tsx#L28"}}],"signature":["(props: ","MarkdownProps",") => JSX.Element"],"description":[],"label":"Markdown","source":{"path":"src/plugins/kibana_react/public/markdown/index.tsx","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/markdown/index.tsx#L28"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.MarkdownSimple","type":"Function","children":[{"type":"Object","label":"props","isRequired":true,"signature":[{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.MarkdownSimpleProps","text":"MarkdownSimpleProps"}],"description":[],"source":{"path":"src/plugins/kibana_react/public/markdown/index.tsx","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/markdown/index.tsx#L21"}}],"signature":["(props: ","MarkdownSimpleProps",") => JSX.Element"],"description":[],"label":"MarkdownSimple","source":{"path":"src/plugins/kibana_react/public/markdown/index.tsx","lineNumber":21,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/markdown/index.tsx#L21"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.reactToUiComponent","type":"Function","children":[{"type":"CompoundType","label":"ReactComp","isRequired":true,"signature":["React.ComponentType"],"description":[],"source":{"path":"src/plugins/kibana_react/public/adapters/react_to_ui_component.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/adapters/react_to_ui_component.ts#L19"}}],"signature":["(ReactComp: React.ComponentType) => ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.UiComponent","text":"UiComponent"},""],"description":["\nTransform a React component into a `UiComponent`.\n"],"label":"reactToUiComponent","source":{"path":"src/plugins/kibana_react/public/adapters/react_to_ui_component.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/adapters/react_to_ui_component.ts#L18"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.uiToReactComponent","type":"Function","children":[{"type":"Function","label":"Comp","isRequired":true,"signature":[{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.UiComponent","text":"UiComponent"},""],"description":[],"source":{"path":"src/plugins/kibana_react/public/adapters/ui_to_react_component.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/adapters/ui_to_react_component.ts#L16"}},{"type":"string","label":"as","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/kibana_react/public/adapters/ui_to_react_component.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/adapters/ui_to_react_component.ts#L17"}}],"signature":["(Comp: ",{"pluginId":"kibanaUtils","scope":"common","docId":"kibKibanaUtilsPluginApi","section":"def-common.UiComponent","text":"UiComponent"},", as?: string) => React.FC"],"description":["\nTransforms `UiComponent` into a React component."],"label":"uiToReactComponent","source":{"path":"src/plugins/kibana_react/public/adapters/ui_to_react_component.ts","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/adapters/ui_to_react_component.ts#L15"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.toMountPoint","type":"Function","children":[{"type":"CompoundType","label":"node","isRequired":false,"signature":["React.ReactNode"],"description":[],"source":{"path":"src/plugins/kibana_react/public/util/to_mount_point.tsx","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/util/to_mount_point.tsx#L19"}}],"signature":["(node: React.ReactNode) => ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.MountPoint","text":"MountPoint"},""],"description":["\nMountPoint converter for react nodes.\n"],"label":"toMountPoint","source":{"path":"src/plugins/kibana_react/public/util/to_mount_point.tsx","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/util/to_mount_point.tsx#L19"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.MountPointPortal","type":"Function","children":[{"type":"CompoundType","label":"{ children, setMountPoint }","isRequired":true,"signature":["React.PropsWithChildren"],"description":[],"source":{"path":"src/plugins/kibana_react/public/util/mount_point_portal.tsx","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/util/mount_point_portal.tsx#L22"}}],"signature":["({ children, setMountPoint }: React.PropsWithChildren) => React.ReactPortal | null"],"description":["\nUtility component to portal a part of a react application into the provided `MountPoint`."],"label":"MountPointPortal","source":{"path":"src/plugins/kibana_react/public/util/mount_point_portal.tsx","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/util/mount_point_portal.tsx#L22"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.RedirectAppLinks","type":"Function","children":[{"type":"CompoundType","label":"{\n application,\n children,\n className,\n ...otherProps\n}","isRequired":true,"signature":["React.PropsWithChildren"],"description":[],"source":{"path":"src/plugins/kibana_react/public/app_links/redirect_app_link.tsx","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/app_links/redirect_app_link.tsx#L38"}}],"signature":["({ application, children, className, ...otherProps }: React.PropsWithChildren) => JSX.Element"],"description":["\nUtility component that will intercept click events on children anchor (``) elements to call\n`application.navigateToUrl` with the link's href. This will trigger SPA friendly navigation\nwhen the link points to a valid Kibana app.\n"],"label":"RedirectAppLinks","source":{"path":"src/plugins/kibana_react/public/app_links/redirect_app_link.tsx","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/app_links/redirect_app_link.tsx#L38"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.CodeEditor","type":"Function","children":[{"type":"CompoundType","label":"props","isRequired":true,"signature":["React.PropsWithChildren<",{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.Props","text":"Props"},">"],"description":[],"source":{"path":"src/plugins/kibana_react/public/code_editor/index.tsx","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/code_editor/index.tsx#L22"}}],"signature":["(props: React.PropsWithChildren<","Props",">) => JSX.Element"],"description":[],"label":"CodeEditor","source":{"path":"src/plugins/kibana_react/public/code_editor/index.tsx","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/code_editor/index.tsx#L22"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.UrlTemplateEditor","type":"Function","children":[{"type":"CompoundType","label":"{\n height = 105,\n value,\n variables,\n onChange,\n onEditor,\n Editor = CodeEditor,\n}","isRequired":true,"signature":["React.PropsWithChildren<",{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.UrlTemplateEditorProps","text":"UrlTemplateEditorProps"},">"],"description":[],"source":{"path":"src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx#L40"}}],"signature":["({ height, value, variables, onChange, onEditor, Editor, }: React.PropsWithChildren<",{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.UrlTemplateEditorProps","text":"UrlTemplateEditorProps"},">) => JSX.Element"],"description":[],"label":"UrlTemplateEditor","source":{"path":"src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx","lineNumber":40,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx#L40"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.createKibanaReactContext","type":"Function","children":[{"type":"Uncategorized","label":"services","isRequired":true,"signature":["Services"],"description":[],"source":{"path":"src/plugins/kibana_react/public/context/context.tsx","lineNumber":46,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/context.tsx#L46"}}],"signature":[">(services: Services) => ",{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.KibanaReactContext","text":"KibanaReactContext"},""],"description":[],"label":"createKibanaReactContext","source":{"path":"src/plugins/kibana_react/public/context/context.tsx","lineNumber":45,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/context.tsx#L45"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.KibanaContextProvider","type":"Function","label":"KibanaContextProvider","description":[],"source":{"path":"src/plugins/kibana_react/public/context/context.tsx","lineNumber":76,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/context.tsx#L76"},"signature":["React.FC<{ services?: {} | undefined; }>"],"initialIsOpen":false},{"id":"def-public.useKibana","type":"Function","children":[],"signature":["() => ",{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.KibanaReactContextValue","text":"KibanaReactContextValue"}," & Extra>"],"description":[],"label":"useKibana","source":{"path":"src/plugins/kibana_react/public/context/context.tsx","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/context.tsx#L24"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.withKibana","type":"Function","children":[{"type":"CompoundType","label":"type","isRequired":true,"signature":["React.ComponentType"],"description":[],"source":{"path":"src/plugins/kibana_react/public/context/context.tsx","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/context.tsx#L32"}}],"signature":["; }>(type: React.ComponentType) => React.FC>>"],"description":[],"label":"withKibana","source":{"path":"src/plugins/kibana_react/public/context/context.tsx","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/context.tsx#L31"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.UseKibana","type":"Function","children":[{"type":"CompoundType","label":"{ children }","isRequired":true,"signature":["React.PropsWithChildren<{ children: (kibana: ",{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.KibanaReactContextValue","text":"KibanaReactContextValue"},") => React.ReactNode; }>"],"description":[],"source":{"path":"src/plugins/kibana_react/public/context/context.tsx","lineNumber":43,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/context.tsx#L43"}}],"signature":["({ children }: React.PropsWithChildren<{ children: (kibana: ",{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.KibanaReactContextValue","text":"KibanaReactContextValue"},") => React.ReactNode; }>) => JSX.Element"],"description":[],"label":"UseKibana","source":{"path":"src/plugins/kibana_react/public/context/context.tsx","lineNumber":41,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/context.tsx#L41"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.OverviewPageFooter","type":"Function","children":[{"type":"CompoundType","label":"{\n addBasePath,\n path,\n onSetDefaultRoute,\n onChangeDefaultRoute,\n}","isRequired":true,"signature":["React.PropsWithChildren"],"description":[],"source":{"path":"src/plugins/kibana_react/public/overview_page/overview_page_footer/overview_page_footer.tsx","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/overview_page/overview_page_footer/overview_page_footer.tsx#L28"}}],"signature":["({ addBasePath, path, onSetDefaultRoute, onChangeDefaultRoute, }: React.PropsWithChildren) => JSX.Element"],"description":[],"label":"OverviewPageFooter","source":{"path":"src/plugins/kibana_react/public/overview_page/overview_page_footer/overview_page_footer.tsx","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/overview_page/overview_page_footer/overview_page_footer.tsx#L28"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.OverviewPageHeader","type":"Function","children":[{"type":"CompoundType","label":"{\n hideToolbar,\n iconType,\n overlap,\n showDevToolsLink,\n showManagementLink,\n title,\n addBasePath,\n}","isRequired":true,"signature":["React.PropsWithChildren"],"description":[],"source":{"path":"src/plugins/kibana_react/public/overview_page/overview_page_header/overview_page_header.tsx","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/overview_page/overview_page_header/overview_page_header.tsx#L35"}}],"signature":["({ hideToolbar, iconType, overlap, showDevToolsLink, showManagementLink, title, addBasePath, }: React.PropsWithChildren) => JSX.Element"],"description":[],"label":"OverviewPageHeader","source":{"path":"src/plugins/kibana_react/public/overview_page/overview_page_header/overview_page_header.tsx","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/overview_page/overview_page_header/overview_page_header.tsx#L35"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.createReactOverlays","type":"Function","children":[{"type":"Object","label":"services","isRequired":true,"signature":["Partial<",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreStart","text":"CoreStart"},">"],"description":[],"source":{"path":"src/plugins/kibana_react/public/overlays/create_react_overlays.tsx","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/overlays/create_react_overlays.tsx#L14"}}],"signature":["(services: Partial<",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreStart","text":"CoreStart"},">) => ",{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.KibanaReactOverlays","text":"KibanaReactOverlays"}],"description":[],"label":"createReactOverlays","source":{"path":"src/plugins/kibana_react/public/overlays/create_react_overlays.tsx","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/overlays/create_react_overlays.tsx#L14"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.useUiSetting","type":"Function","children":[{"type":"string","label":"key","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/kibana_react/public/ui_settings/use_ui_setting.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/ui_settings/use_ui_setting.ts#L22"}},{"type":"Uncategorized","label":"defaultValue","isRequired":false,"signature":["T | undefined"],"description":[],"source":{"path":"src/plugins/kibana_react/public/ui_settings/use_ui_setting.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/ui_settings/use_ui_setting.ts#L22"}}],"signature":["(key: string, defaultValue?: T | undefined) => T"],"description":["\nReturns the current UI-settings value.\n\nUsage:\n\n```js\nconst darkMode = useUiSetting('theme:darkMode');\n```"],"label":"useUiSetting","source":{"path":"src/plugins/kibana_react/public/ui_settings/use_ui_setting.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/ui_settings/use_ui_setting.ts#L22"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.useUiSetting$","type":"Function","children":[{"type":"string","label":"key","isRequired":true,"signature":["string"],"description":[],"source":{"path":"src/plugins/kibana_react/public/ui_settings/use_ui_setting.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/ui_settings/use_ui_setting.ts#L47"}},{"type":"Uncategorized","label":"defaultValue","isRequired":false,"signature":["T | undefined"],"description":[],"source":{"path":"src/plugins/kibana_react/public/ui_settings/use_ui_setting.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/ui_settings/use_ui_setting.ts#L47"}}],"signature":["(key: string, defaultValue?: T | undefined) => [T, Setter]"],"description":["\nReturns a 2-tuple, where first entry is the setting value and second is a\nfunction to update the setting value.\n\nSynchronously returns the most current value of the setting and subscribes\nto all subsequent updates, which will re-render your component on new values.\n\nUsage:\n\n```js\nconst [darkMode, setDarkMode] = useUiSetting$('theme:darkMode');\n```"],"label":"useUiSetting$","source":{"path":"src/plugins/kibana_react/public/ui_settings/use_ui_setting.ts","lineNumber":47,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/ui_settings/use_ui_setting.ts#L47"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.FieldIcon","type":"Function","label":"FieldIcon","signature":["({\n type,\n label,\n size = 's',\n scripted,\n className,\n ...rest\n}: ",{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.FieldIconProps","text":"FieldIconProps"},") => JSX.Element"],"description":["\nField token icon used across the app"],"children":[{"type":"Object","label":"{\n type,\n label,\n size = 's',\n scripted,\n className,\n ...rest\n}","isRequired":true,"signature":[{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.FieldIconProps","text":"FieldIconProps"}],"description":[],"source":{"path":"src/plugins/kibana_react/public/field_icon/field_icon.tsx","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/field_icon/field_icon.tsx#L53"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_react/public/field_icon/field_icon.tsx","lineNumber":53,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/field_icon/field_icon.tsx#L53"},"initialIsOpen":false},{"id":"def-public.FieldButton","type":"Function","label":"FieldButton","signature":["({\n size = 'm',\n isActive = false,\n fieldIcon,\n fieldName,\n fieldInfoIcon,\n fieldAction,\n className,\n isDraggable = false,\n onClick,\n dataTestSubj,\n buttonProps,\n ...rest\n}: ",{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.FieldButtonProps","text":"FieldButtonProps"},") => JSX.Element"],"description":[],"children":[{"type":"Object","label":"{\n size = 'm',\n isActive = false,\n fieldIcon,\n fieldName,\n fieldInfoIcon,\n fieldAction,\n className,\n isDraggable = false,\n onClick,\n dataTestSubj,\n buttonProps,\n ...rest\n}","isRequired":true,"signature":[{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.FieldButtonProps","text":"FieldButtonProps"}],"description":[],"source":{"path":"src/plugins/kibana_react/public/field_button/field_button.tsx","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/field_button/field_button.tsx#L68"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_react/public/field_button/field_button.tsx","lineNumber":68,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/field_button/field_button.tsx#L68"},"initialIsOpen":false},{"id":"def-public.ToolbarButton","type":"Function","children":[{"type":"CompoundType","label":"{\n children,\n className,\n fontWeight = 'normal',\n size = 'm',\n hasArrow = true,\n groupPosition = 'none',\n dataTestSubj = '',\n ...rest\n}","isRequired":true,"signature":["React.PropsWithChildren<",{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.ToolbarButtonProps","text":"ToolbarButtonProps"},">"],"description":[],"source":{"path":"src/plugins/kibana_react/public/toolbar_button/toolbar_button.tsx","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/toolbar_button/toolbar_button.tsx#L49"}}],"signature":["({ children, className, fontWeight, size, hasArrow, groupPosition, dataTestSubj, ...rest }: React.PropsWithChildren<",{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.ToolbarButtonProps","text":"ToolbarButtonProps"},">) => JSX.Element"],"description":[],"label":"ToolbarButton","source":{"path":"src/plugins/kibana_react/public/toolbar_button/toolbar_button.tsx","lineNumber":49,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/toolbar_button/toolbar_button.tsx#L49"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.Panel","type":"Function","label":"Panel","signature":["({ children, className, initialWidth = 100, style = {} }: ","Props",") => JSX.Element"],"description":[],"children":[{"type":"Object","label":"{ children, className, initialWidth = 100, style = {} }","isRequired":true,"signature":[{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.Props","text":"Props"}],"description":[],"source":{"path":"src/plugins/kibana_react/public/split_panel/containers/panel.tsx","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/split_panel/containers/panel.tsx#L23"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_react/public/split_panel/containers/panel.tsx","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/split_panel/containers/panel.tsx#L23"},"initialIsOpen":false},{"id":"def-public.PanelsContainer","type":"Function","label":"PanelsContainer","signature":["({\n children,\n className,\n onPanelWidthChange,\n resizerClassName,\n}: ","Props",") => JSX.Element"],"description":[],"children":[{"type":"Object","label":"{\n children,\n className,\n onPanelWidthChange,\n resizerClassName,\n}","isRequired":true,"signature":[{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.Props","text":"Props"}],"description":[],"source":{"path":"src/plugins/kibana_react/public/split_panel/containers/panel_container.tsx","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/split_panel/containers/panel_container.tsx#L32"}}],"tags":[],"returnComment":[],"source":{"path":"src/plugins/kibana_react/public/split_panel/containers/panel_container.tsx","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/split_panel/containers/panel_container.tsx#L32"},"initialIsOpen":false},{"id":"def-public.reactRouterNavigate","type":"Function","children":[{"type":"CompoundType","label":"history","isRequired":true,"signature":["History"," | ",{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.ScopedHistory","text":"ScopedHistory"},""],"description":[],"source":{"path":"src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx#L27"}},{"type":"CompoundType","label":"to","isRequired":true,"signature":["string | LocationObject"],"description":[],"source":{"path":"src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx#L28"}},{"type":"Object","label":"onClickCallback","isRequired":false,"signature":["Function | undefined"],"description":[],"source":{"path":"src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx#L29"}}],"signature":["(history: ","History"," | ",{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.ScopedHistory","text":"ScopedHistory"},", to: string | LocationObject, onClickCallback?: Function | undefined) => { href: string; onClick: (event: any) => void; }"],"description":[],"label":"reactRouterNavigate","source":{"path":"src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx#L26"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.reactRouterOnClickHandler","type":"Function","children":[{"type":"CompoundType","label":"history","isRequired":true,"signature":["History"," | ",{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.ScopedHistory","text":"ScopedHistory"},""],"description":[],"source":{"path":"src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx#L36"}},{"type":"CompoundType","label":"to","isRequired":true,"signature":["string | LocationObject"],"description":[],"source":{"path":"src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx#L37"}},{"type":"Object","label":"onClickCallback","isRequired":false,"signature":["Function | undefined"],"description":[],"source":{"path":"src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx","lineNumber":38,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx#L38"}}],"signature":["(history: ","History"," | ",{"pluginId":"core","scope":"public","docId":"kibCoreApplicationPluginApi","section":"def-public.ScopedHistory","text":"ScopedHistory"},", to: string | LocationObject, onClickCallback?: Function | undefined) => (event: any) => void"],"description":[],"label":"reactRouterOnClickHandler","source":{"path":"src/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/react_router_navigate/react_router_navigate.tsx#L35"},"returnComment":[],"initialIsOpen":false},{"id":"def-public.createNotifications","type":"Function","children":[{"type":"Object","label":"services","isRequired":true,"signature":["Partial<",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreStart","text":"CoreStart"},">"],"description":[],"source":{"path":"src/plugins/kibana_react/public/notifications/create_notifications.tsx","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/notifications/create_notifications.tsx#L14"}}],"signature":["(services: Partial<",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.CoreStart","text":"CoreStart"},">) => ",{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.KibanaReactNotifications","text":"KibanaReactNotifications"}],"description":[],"label":"createNotifications","source":{"path":"src/plugins/kibana_react/public/notifications/create_notifications.tsx","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/notifications/create_notifications.tsx#L14"},"returnComment":[],"initialIsOpen":false}],"interfaces":[{"id":"def-public.UrlTemplateEditorVariable","type":"Interface","label":"UrlTemplateEditorVariable","description":[],"children":[{"id":"def-public.UrlTemplateEditorVariable.label","type":"string","label":"label","description":[],"source":{"path":"src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx#L25"}},{"id":"def-public.UrlTemplateEditorVariable.title","type":"string","label":"title","description":[],"source":{"path":"src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx","lineNumber":26,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx#L26"},"signature":["string | undefined"]},{"id":"def-public.UrlTemplateEditorVariable.documentation","type":"string","label":"documentation","description":[],"source":{"path":"src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx#L27"},"signature":["string | undefined"]},{"id":"def-public.UrlTemplateEditorVariable.kind","type":"CompoundType","label":"kind","description":[],"source":{"path":"src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx#L28"},"signature":["languages",".CompletionItemKind | undefined"]},{"id":"def-public.UrlTemplateEditorVariable.sortText","type":"string","label":"sortText","description":[],"source":{"path":"src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx","lineNumber":29,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx#L29"},"signature":["string | undefined"]}],"source":{"path":"src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx#L24"},"initialIsOpen":false},{"id":"def-public.UrlTemplateEditorProps","type":"Interface","label":"UrlTemplateEditorProps","description":[],"children":[{"id":"def-public.UrlTemplateEditorProps.value","type":"string","label":"value","description":[],"source":{"path":"src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx","lineNumber":32,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx#L32"}},{"id":"def-public.UrlTemplateEditorProps.height","type":"CompoundType","label":"height","description":[],"source":{"path":"src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx","lineNumber":33,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx#L33"},"signature":["string | number | undefined"]},{"id":"def-public.UrlTemplateEditorProps.variables","type":"Array","label":"variables","description":[],"source":{"path":"src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx","lineNumber":34,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx#L34"},"signature":[{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.UrlTemplateEditorVariable","text":"UrlTemplateEditorVariable"},"[] | undefined"]},{"id":"def-public.UrlTemplateEditorProps.onChange","type":"Function","label":"onChange","description":[],"source":{"path":"src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx","lineNumber":35,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx#L35"},"signature":["(value: string) => void"]},{"id":"def-public.UrlTemplateEditorProps.onEditor","type":"Function","label":"onEditor","description":[],"source":{"path":"src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx","lineNumber":36,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx#L36"},"signature":["((editor: ","editor",".IStandaloneCodeEditor) => void) | undefined"]},{"id":"def-public.UrlTemplateEditorProps.Editor","type":"CompoundType","label":"Editor","description":[],"source":{"path":"src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx","lineNumber":37,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx#L37"},"signature":["React.FunctionComponent<",{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.Props","text":"Props"},"> | React.ComponentClass<",{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.Props","text":"Props"},", any> | undefined"]}],"source":{"path":"src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx","lineNumber":31,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx#L31"},"initialIsOpen":false},{"id":"def-public.ExitFullScreenButtonProps","type":"Interface","label":"ExitFullScreenButtonProps","description":[],"children":[{"id":"def-public.ExitFullScreenButtonProps.onExitFullScreenMode","type":"Function","label":"onExitFullScreenMode","description":[],"source":{"path":"src/plugins/kibana_react/public/exit_full_screen_button/exit_full_screen_button.tsx","lineNumber":15,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/exit_full_screen_button/exit_full_screen_button.tsx#L15"},"signature":["() => void"]}],"source":{"path":"src/plugins/kibana_react/public/exit_full_screen_button/exit_full_screen_button.tsx","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/exit_full_screen_button/exit_full_screen_button.tsx#L14"},"initialIsOpen":false},{"id":"def-public.KibanaReactContext","type":"Interface","label":"KibanaReactContext","signature":[{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.KibanaReactContext","text":"KibanaReactContext"},""],"description":[],"children":[{"id":"def-public.KibanaReactContext.value","type":"Object","label":"value","description":[],"source":{"path":"src/plugins/kibana_react/public/context/types.ts","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/types.ts#L23"},"signature":[{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.KibanaReactContextValue","text":"KibanaReactContextValue"},""]},{"id":"def-public.KibanaReactContext.Provider","type":"Function","label":"Provider","description":[],"source":{"path":"src/plugins/kibana_react/public/context/types.ts","lineNumber":24,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/types.ts#L24"},"signature":["React.FC<{ services?: T | undefined; }>"]},{"id":"def-public.KibanaReactContext.Consumer","type":"Function","label":"Consumer","description":[],"source":{"path":"src/plugins/kibana_react/public/context/types.ts","lineNumber":25,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/types.ts#L25"},"signature":["React.Consumer<",{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.KibanaReactContextValue","text":"KibanaReactContextValue"},">"]}],"source":{"path":"src/plugins/kibana_react/public/context/types.ts","lineNumber":22,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/types.ts#L22"},"initialIsOpen":false},{"id":"def-public.KibanaReactContextValue","type":"Interface","label":"KibanaReactContextValue","signature":[{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.KibanaReactContextValue","text":"KibanaReactContextValue"},""],"description":[],"children":[{"id":"def-public.KibanaReactContextValue.services","type":"Uncategorized","label":"services","description":[],"source":{"path":"src/plugins/kibana_react/public/context/types.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/types.ts#L17"},"signature":["Services"]},{"id":"def-public.KibanaReactContextValue.overlays","type":"Object","label":"overlays","description":[],"source":{"path":"src/plugins/kibana_react/public/context/types.ts","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/types.ts#L18"},"signature":[{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.KibanaReactOverlays","text":"KibanaReactOverlays"}]},{"id":"def-public.KibanaReactContextValue.notifications","type":"Object","label":"notifications","description":[],"source":{"path":"src/plugins/kibana_react/public/context/types.ts","lineNumber":19,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/types.ts#L19"},"signature":[{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.KibanaReactNotifications","text":"KibanaReactNotifications"}]}],"source":{"path":"src/plugins/kibana_react/public/context/types.ts","lineNumber":16,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/context/types.ts#L16"},"initialIsOpen":false},{"id":"def-public.KibanaReactOverlays","type":"Interface","label":"KibanaReactOverlays","description":[],"children":[{"id":"def-public.KibanaReactOverlays.openFlyout","type":"Function","label":"openFlyout","description":[],"source":{"path":"src/plugins/kibana_react/public/overlays/types.ts","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/overlays/types.ts#L13"},"signature":["(node: React.ReactNode, options?: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.OverlayFlyoutOpenOptions","text":"OverlayFlyoutOpenOptions"}," | undefined) => ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.OverlayRef","text":"OverlayRef"}]},{"id":"def-public.KibanaReactOverlays.openModal","type":"Function","label":"openModal","description":[],"source":{"path":"src/plugins/kibana_react/public/overlays/types.ts","lineNumber":17,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/overlays/types.ts#L17"},"signature":["(node: React.ReactNode, options?: ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.OverlayModalOpenOptions","text":"OverlayModalOpenOptions"}," | undefined) => ",{"pluginId":"core","scope":"public","docId":"kibCorePluginApi","section":"def-public.OverlayRef","text":"OverlayRef"}]}],"source":{"path":"src/plugins/kibana_react/public/overlays/types.ts","lineNumber":12,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/overlays/types.ts#L12"},"initialIsOpen":false},{"id":"def-public.FieldIconProps","type":"Interface","label":"FieldIconProps","signature":[{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.FieldIconProps","text":"FieldIconProps"}," extends Pick<","EuiTokenProps",", \"children\" | \"onClick\" | \"onChange\" | \"color\" | \"id\" | \"title\" | \"size\" | \"placeholder\" | \"defaultChecked\" | \"defaultValue\" | \"suppressContentEditableWarning\" | \"suppressHydrationWarning\" | \"accessKey\" | \"className\" | \"contentEditable\" | \"contextMenu\" | \"dir\" | \"draggable\" | \"hidden\" | \"lang\" | \"slot\" | \"spellCheck\" | \"style\" | \"tabIndex\" | \"translate\" | \"radioGroup\" | \"role\" | \"about\" | \"datatype\" | \"inlist\" | \"prefix\" | \"property\" | \"resource\" | \"typeof\" | \"vocab\" | \"autoCapitalize\" | \"autoCorrect\" | \"autoSave\" | \"itemProp\" | \"itemScope\" | \"itemType\" | \"itemID\" | \"itemRef\" | \"results\" | \"security\" | \"unselectable\" | \"inputMode\" | \"is\" | \"aria-activedescendant\" | \"aria-atomic\" | \"aria-autocomplete\" | \"aria-busy\" | \"aria-checked\" | \"aria-colcount\" | \"aria-colindex\" | \"aria-colspan\" | \"aria-controls\" | \"aria-current\" | \"aria-describedby\" | \"aria-details\" | \"aria-disabled\" | \"aria-dropeffect\" | \"aria-errormessage\" | \"aria-expanded\" | \"aria-flowto\" | \"aria-grabbed\" | \"aria-haspopup\" | \"aria-hidden\" | \"aria-invalid\" | \"aria-keyshortcuts\" | \"aria-label\" | \"aria-labelledby\" | \"aria-level\" | \"aria-live\" | \"aria-modal\" | \"aria-multiline\" | \"aria-multiselectable\" | \"aria-orientation\" | \"aria-owns\" | \"aria-placeholder\" | \"aria-posinset\" | \"aria-pressed\" | \"aria-readonly\" | \"aria-relevant\" | \"aria-required\" | \"aria-roledescription\" | \"aria-rowcount\" | \"aria-rowindex\" | \"aria-rowspan\" | \"aria-selected\" | \"aria-setsize\" | \"aria-sort\" | \"aria-valuemax\" | \"aria-valuemin\" | \"aria-valuenow\" | \"aria-valuetext\" | \"dangerouslySetInnerHTML\" | \"onCopy\" | \"onCopyCapture\" | \"onCut\" | \"onCutCapture\" | \"onPaste\" | \"onPasteCapture\" | \"onCompositionEnd\" | \"onCompositionEndCapture\" | \"onCompositionStart\" | \"onCompositionStartCapture\" | \"onCompositionUpdate\" | \"onCompositionUpdateCapture\" | \"onFocus\" | \"onFocusCapture\" | \"onBlur\" | \"onBlurCapture\" | \"onChangeCapture\" | \"onBeforeInput\" | \"onBeforeInputCapture\" | \"onInput\" | \"onInputCapture\" | \"onReset\" | \"onResetCapture\" | \"onSubmit\" | \"onSubmitCapture\" | \"onInvalid\" | \"onInvalidCapture\" | \"onLoad\" | \"onLoadCapture\" | \"onError\" | \"onErrorCapture\" | \"onKeyDown\" | \"onKeyDownCapture\" | \"onKeyPress\" | \"onKeyPressCapture\" | \"onKeyUp\" | \"onKeyUpCapture\" | \"onAbort\" | \"onAbortCapture\" | \"onCanPlay\" | \"onCanPlayCapture\" | \"onCanPlayThrough\" | \"onCanPlayThroughCapture\" | \"onDurationChange\" | \"onDurationChangeCapture\" | \"onEmptied\" | \"onEmptiedCapture\" | \"onEncrypted\" | \"onEncryptedCapture\" | \"onEnded\" | \"onEndedCapture\" | \"onLoadedData\" | \"onLoadedDataCapture\" | \"onLoadedMetadata\" | \"onLoadedMetadataCapture\" | \"onLoadStart\" | \"onLoadStartCapture\" | \"onPause\" | \"onPauseCapture\" | \"onPlay\" | \"onPlayCapture\" | \"onPlaying\" | \"onPlayingCapture\" | \"onProgress\" | \"onProgressCapture\" | \"onRateChange\" | \"onRateChangeCapture\" | \"onSeeked\" | \"onSeekedCapture\" | \"onSeeking\" | \"onSeekingCapture\" | \"onStalled\" | \"onStalledCapture\" | \"onSuspend\" | \"onSuspendCapture\" | \"onTimeUpdate\" | \"onTimeUpdateCapture\" | \"onVolumeChange\" | \"onVolumeChangeCapture\" | \"onWaiting\" | \"onWaitingCapture\" | \"onAuxClick\" | \"onAuxClickCapture\" | \"onClickCapture\" | \"onContextMenu\" | \"onContextMenuCapture\" | \"onDoubleClick\" | \"onDoubleClickCapture\" | \"onDrag\" | \"onDragCapture\" | \"onDragEnd\" | \"onDragEndCapture\" | \"onDragEnter\" | \"onDragEnterCapture\" | \"onDragExit\" | \"onDragExitCapture\" | \"onDragLeave\" | \"onDragLeaveCapture\" | \"onDragOver\" | \"onDragOverCapture\" | \"onDragStart\" | \"onDragStartCapture\" | \"onDrop\" | \"onDropCapture\" | \"onMouseDown\" | \"onMouseDownCapture\" | \"onMouseEnter\" | \"onMouseLeave\" | \"onMouseMove\" | \"onMouseMoveCapture\" | \"onMouseOut\" | \"onMouseOutCapture\" | \"onMouseOver\" | \"onMouseOverCapture\" | \"onMouseUp\" | \"onMouseUpCapture\" | \"onSelect\" | \"onSelectCapture\" | \"onTouchCancel\" | \"onTouchCancelCapture\" | \"onTouchEnd\" | \"onTouchEndCapture\" | \"onTouchMove\" | \"onTouchMoveCapture\" | \"onTouchStart\" | \"onTouchStartCapture\" | \"onPointerDown\" | \"onPointerDownCapture\" | \"onPointerMove\" | \"onPointerMoveCapture\" | \"onPointerUp\" | \"onPointerUpCapture\" | \"onPointerCancel\" | \"onPointerCancelCapture\" | \"onPointerEnter\" | \"onPointerEnterCapture\" | \"onPointerLeave\" | \"onPointerLeaveCapture\" | \"onPointerOver\" | \"onPointerOverCapture\" | \"onPointerOut\" | \"onPointerOutCapture\" | \"onGotPointerCapture\" | \"onGotPointerCaptureCapture\" | \"onLostPointerCapture\" | \"onLostPointerCaptureCapture\" | \"onScroll\" | \"onScrollCapture\" | \"onWheel\" | \"onWheelCapture\" | \"onAnimationStart\" | \"onAnimationStartCapture\" | \"onAnimationEnd\" | \"onAnimationEndCapture\" | \"onAnimationIteration\" | \"onAnimationIterationCapture\" | \"onTransitionEnd\" | \"onTransitionEndCapture\" | \"css\" | \"data-test-subj\" | \"fill\" | \"shape\">"],"description":[],"children":[{"id":"def-public.FieldIconProps.type","type":"string","label":"type","description":[],"source":{"path":"src/plugins/kibana_react/public/field_icon/field_icon.tsx","lineNumber":14,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/field_icon/field_icon.tsx#L14"}},{"id":"def-public.FieldIconProps.label","type":"string","label":"label","description":[],"source":{"path":"src/plugins/kibana_react/public/field_icon/field_icon.tsx","lineNumber":27,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/field_icon/field_icon.tsx#L27"},"signature":["string | undefined"]},{"id":"def-public.FieldIconProps.scripted","type":"CompoundType","label":"scripted","description":[],"source":{"path":"src/plugins/kibana_react/public/field_icon/field_icon.tsx","lineNumber":28,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/field_icon/field_icon.tsx#L28"},"signature":["boolean | undefined"]}],"source":{"path":"src/plugins/kibana_react/public/field_icon/field_icon.tsx","lineNumber":13,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/field_icon/field_icon.tsx#L13"},"initialIsOpen":false},{"id":"def-public.FieldButtonProps","type":"Interface","label":"FieldButtonProps","signature":[{"pluginId":"kibanaReact","scope":"public","docId":"kibKibanaReactPluginApi","section":"def-public.FieldButtonProps","text":"FieldButtonProps"}," extends React.HTMLAttributes"],"description":[],"children":[{"id":"def-public.FieldButtonProps.fieldName","type":"CompoundType","label":"fieldName","description":["\nLabel for the button"],"source":{"path":"src/plugins/kibana_react/public/field_button/field_button.tsx","lineNumber":18,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/field_button/field_button.tsx#L18"},"signature":["React.ReactNode"]},{"id":"def-public.FieldButtonProps.fieldIcon","type":"CompoundType","label":"fieldIcon","description":["\nIcon representing the field type.\nRecommend using FieldIcon"],"source":{"path":"src/plugins/kibana_react/public/field_button/field_button.tsx","lineNumber":23,"link":"https://github.com/elastic/kibana/tree/mastersrc/plugins/kibana_react/public/field_button/field_button.tsx#L23"},"signature":["React.ReactNode"]},{"id":"def-public.FieldButtonProps.fieldInfoIcon","type":"CompoundType","label":"fieldInfoIcon","description":["\nAn optional node to place inside and at the end of the